Skip to content

Commit 5056697

Browse files
romanmichalvasko
authored andcommitted
doc UPDATE add kbdint paragraph to the docs
1 parent 21f3783 commit 5056697

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

doc/libnetconf.doc

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -351,8 +351,7 @@
351351
*
352352
* If you wish not to create the __YANG data__ yourself, you may use the library's functions to do this for you.
353353
* For example ::nc_server_config_add_address_port() creates __YANG data__ corresponding to an SSH/TLS endpoint.
354-
* The variant for UNIX socket is ::nc_server_config_add_unix_socket(). You can then apply this data
355-
* by calling ::nc_server_config_setup_data() (or ::nc_server_config_setup_diff() for diff).
354+
* You can then apply this data by calling ::nc_server_config_setup_data() (or ::nc_server_config_setup_diff() for diff).
356355
* See *examples/server.c* for a simple example.
357356
*
358357
* You may also create entries in the keystore or truststore. For example the asymmetric key and certificate entries
@@ -371,7 +370,6 @@
371370
* - ::nc_server_config_setup_path()
372371
*
373372
* - ::nc_server_config_add_address_port()
374-
* - ::nc_server_config_add_unix_socket()
375373
* - ::nc_server_config_del_endpt()
376374
* - ::nc_server_config_add_keystore_asym_key()
377375
* - ::nc_server_config_del_keystore_asym_key()
@@ -393,6 +391,14 @@
393391
* Another option for authorized clients is to reference another endpoint's clients, however be careful not to create a cyclic reference
394392
* (see ::nc_server_config_add_ssh_endpoint_client_ref()). An authorized client MUST authenticate to all of it's configured authentication methods.
395393
*
394+
* \anchor ln2doc_kbdint
395+
* The Keyboard Interactive authentication method is also supported. It can be done in three ways.
396+
* 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().
397+
* Else if the standard functions for accessing local users are found on the system, they are used. The only Keyboard Interactive challenge will be the given
398+
* user's password (that is if he's found on the system).
399+
* Either way, you can always define your own callback to perform the authentication, see ::nc_server_ssh_set_interactive_auth_clb().
400+
* The callback has a higher priority than the other two methods.
401+
*
396402
* There are also some other optional settings.
397403
*
398404
* Functions List
@@ -417,6 +423,9 @@
417423
* - ::nc_server_config_add_ssh_endpoint_client_ref()
418424
* - ::nc_server_config_del_ssh_endpoint_client_ref()
419425
*
426+
* - ::nc_server_ssh_set_pam_conf_filename()
427+
* - ::nc_server_ssh_set_interactive_auth_clb()
428+
*
420429
* TLS
421430
* ===
422431
*

0 commit comments

Comments
 (0)