Skip to content

Commit

Permalink
doc UPDATE add kbdint paragraph to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
roman committed Nov 30, 2023
1 parent 3b51bdb commit 373432d
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions doc/libnetconf.doc
Original file line number Diff line number Diff line change
Expand Up @@ -348,8 +348,7 @@
*
* If you wish not to create the __YANG data__ yourself, you may use the library's functions to do this for you.
* For example ::nc_server_config_add_address_port() creates __YANG data__ corresponding to an SSH/TLS endpoint.
* The variant for UNIX socket is ::nc_server_config_add_unix_socket(). You can then apply this data
* by calling ::nc_server_config_setup_data() (or ::nc_server_config_setup_diff() for diff).
* You can then apply this data by calling ::nc_server_config_setup_data() (or ::nc_server_config_setup_diff() for diff).
* See *examples/server.c* for a simple example.
*
* You may also create entries in the keystore or truststore. For example the asymmetric key and certificate entries
Expand All @@ -368,7 +367,6 @@
* - ::nc_server_config_setup_path()
*
* - ::nc_server_config_add_address_port()
* - ::nc_server_config_add_unix_socket()
* - ::nc_server_config_del_endpt()
* - ::nc_server_config_add_keystore_asym_key()
* - ::nc_server_config_del_keystore_asym_key()
Expand All @@ -390,6 +388,13 @@
* Another option for authorized clients is to reference another endpoint's clients, however be careful not to create a cyclic reference
* (see ::nc_server_config_add_ssh_endpoint_client_ref()). An authorized client MUST authenticate to all of it's configured authentication methods.
*
* The Keyboard Interactive authentication method is also supported. There are three options.
* The first is to use Linux PAM. You need to specify the service name using ::nc_server_ssh_set_pam_conf_filename().
* The second is to use the system's locally configured user's. The only Keyboard Interactive challenge will be the given
* user's password (that is if he's found on the system).
* The last option is to define your own callback to perform the authentication, see ::nc_server_ssh_set_interactive_auth_clb().
* The callback has a higher priority than the other two methods.
*
* There are also some other optional settings.
*
* Functions List
Expand All @@ -414,6 +419,9 @@
* - ::nc_server_config_add_ssh_endpoint_client_ref()
* - ::nc_server_config_del_ssh_endpoint_client_ref()
*
* - ::nc_server_ssh_set_pam_conf_filename()
* - ::nc_server_ssh_set_interactive_auth_clb()
*
* TLS
* ===
*
Expand Down

0 comments on commit 373432d

Please sign in to comment.