Skip to content

Commit

Permalink
Clarify the documentation surrounding authorized_key field.
Browse files Browse the repository at this point in the history
  • Loading branch information
avanpo committed Dec 12, 2024
1 parent 2cb94b6 commit 5b11d83
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions credentialz/credentialz.proto
Original file line number Diff line number Diff line change
Expand Up @@ -442,18 +442,19 @@ enum KeyType {
KEY_TYPE_ECDSA_P_384 = 7;
}

// AuthorizedKey is an ssh key/idenity. The basic openssh format follows:
// ecdsa-sha2-nistp521 AAAkeystuffhere [email protected]
// key_type authorized_key description
// AuthorizedKey is an SSH key/idenity. The basic OpenSSH format follows:
// ecdsa-sha2-nistp521 AAAkeystuffhere [email protected]
// key_type authorized_key description
message AccountCredentials {
message AuthorizedKey {
// authorized_key is a mandatory field, it is the string format ssh key
// stored as bytes in the message.
// Authorized key, in base64 string format (the second word of the OpenSSH
// format, i.e. `AAAkeystuffhere` in the above example). This field is
// mandatory.
bytes authorized_key = 1;
// Options specified for this authorized key.
// Options are optional.
repeated Option options = 2;
// Key encryption type, this is a mandatory field.
// Key algorithm, this is a mandatory field.
KeyType key_type = 3;
// An optional description of the key.
string description = 4;
Expand Down

0 comments on commit 5b11d83

Please sign in to comment.