Skip to content

Commit d2db90a

Browse files
romanmichalvasko
authored andcommitted
doc UPDATE add paragraph about public key auth
1 parent 60c4ddd commit d2db90a

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

doc/libnetconf.doc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,15 @@
391391
* Another option for authorized clients is to reference another endpoint's clients, however be careful not to create a cyclic reference
392392
* (see ::nc_server_config_add_ssh_endpoint_client_ref()). An authorized client MUST authenticate to all of it's configured authentication methods.
393393
*
394+
* \anchor ln2doc_pubkey
395+
* The Public Key authentication method is supported. If you wish to use this method, you need to specify the given user's
396+
* public keys, which will be compared with the key(s) presented by the SSH client when authenticating. One option is to configure
397+
* the public keys directly in the ietf-netconf-server YANG data (inline-definition). Other option is to configure the keys' data
398+
* in the ietf-trustore module's YANG data and then reference them (truststore-reference). The final option is to set the global
399+
* path to file with public keys. This path may contain special tokens, see ::nc_server_ssh_set_authkey_path_format().
400+
* If the path is set and the use-system-keys container is present in the data for the client wishing to authenticate,
401+
* then the keys from the file will be used for authentication.
402+
*
394403
* \anchor ln2doc_kbdint
395404
* The Keyboard Interactive authentication method is also supported. It can be done in three ways.
396405
* If libpam is found, Linux PAM is used to handle the authentication. You need to specify the service name using ::nc_server_ssh_set_pam_conf_filename().

modules/[email protected]

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,9 +265,15 @@ module libnetconf2-netconf-server {
265265
"Grouping for using the system configured keys in the SSH public key authentication method.";
266266

267267
container use-system-keys {
268-
presence "Indicates that the given user will be authenticated using the system's configured public keys.";
268+
presence
269+
"Indicates that the given user will be authenticated using the system's configured public keys.";
270+
269271
description
270272
"Authentication is done using the system's mechanisms.";
273+
274+
reference
275+
"libnetconf2 documentation:
276+
Section SSH";
271277
}
272278
}
273279

@@ -296,6 +302,10 @@ module libnetconf2-netconf-server {
296302

297303
description
298304
"Authentication is done using the system's mechanisms.";
305+
306+
reference
307+
"libnetconf2 documentation:
308+
Section SSH";
299309
}
300310
}
301311
}

0 commit comments

Comments
 (0)