Public Key Authentication process

Last Updated : Nov 21, 2024 |
  • The Branch Gateway also supports the SSH Public Key Authentication process which allows a user to login using a public/private pair of keys with more cryptographic strength than passwords. The public key is downloaded and associated with a Branch Gateway user account. The private key, also called the identity, is used to authenticate access to the Branch Gateway user account. Therefore, with this method, it is very important to protect access to this private key with an embedded password and/or access for only approved users.

  • With Public Key Authentication on Branch Gateway, it is important to remember that the key pairs are associated with a Branch Gateway local users created by default (For example, root) or with the username command. This should not be confused with the user names on the client system (For example, Linux or Windows) where the keys were created or where the SSH client resides.

  • The Branch Gateway supports public key files (i.e. authorized_keys files) in the OpenSSH format. This key format has the fields in the table below delimited by whitespace. All SSH authorized_keys options used for advanced features (For example, set environment variable, execute command, and more) are ignored.

Key Field

Description

Examples

#

Any line starting with the “#” character is a comment that is ignored.

# BGW1 root authorized_key file

Key Type

A known string describing the type of key.

ssh-rsa

ecdsa-sha2-nistp256

ecdsa-sha2-nistp384

ecdsa-sha2-nistp521

Key Text String

The public key in BASE64 format.

AAAAE2VjZHNh …. AzRQM=

Key Comments

User defined comments about the key.

BGW1-root-key

Example

# BGW1 root authorized_key file

ecdsa-sha2-nistp256 AAAAE2VjZHNh …. AzRQM= BGW1-root-key

  • The file system space reserved for all the public keys is limited to 128KB. This prevents any possible conflict with other Branch Gateway features sharing this space such as announcements.