UDIF: Universal Digital Identification Framework 1.0.0.0a (A1)
A quantum-secure cryptographic identification
commands.h File Reference

The UDIF command enumerations. More...

#include "udif.h"

Go to the source code of this file.

Typedefs

typedef enum udif_console_commands udif_console_commands
typedef enum udif_application_messages udif_application_messages
typedef enum udif_command_actions udif_command_actions
typedef enum udif_console_modes udif_console_modes

Enumerations

enum  udif_console_commands {
  udif_commands_none = 0x00U , udif_commands_certificate_create = 0x01U , udif_commands_certificate_change = 0x02U , udif_commands_certificate_sign = 0x03U ,
  udif_commands_certificate_revoke = 0x04U , udif_commands_certificate_format = 0x05U , udif_commands_device_add = 0x06U , udif_commands_network_converge = 0x07U ,
  udif_commands_adc_election = 0x08U
}
 The common console functions. More...
enum  udif_application_messages {
  udif_application_not_recognized = 0x00U , udif_application_erase_erase_all = 0x01U , udif_application_erase_config = 0x02U , udif_application_erase_log = 0x03U ,
  udif_application_authorization_failure = 0x04U , udif_application_retries_exceeded = 0x05U , udif_application_application_quit = 0x06U , udif_application_logging_disabled = 0x07U ,
  udif_application_logging_enabled = 0x08U , udif_application_authentication_failure = 0x09U , udif_application_operation_aborted = 0x0AU , udif_application_system_erased = 0x0BU ,
  udif_application_configuration_erased = 0x0CU , udif_application_log_erased = 0x0DU , udif_application_retry_invalid = 0x0EU , udif_application_timeout_invalid = 0x0FU ,
  udif_application_domain_invalid = 0x10U , udif_application_hostname_invalid = 0x11U , udif_application_configuration = 0x12U , udif_application_connection = 0x13U ,
  udif_application_connection_details = 0x14U , udif_application_log_empty = 0x15U , udif_application_first_login = 0x16U , udif_application_choose_name = 0x17U ,
  udif_application_choose_password = 0x18U , udif_application_password_set = 0x19U , udif_application_challenge_user = 0x1AU , udif_application_challenge_user_failure = 0x1BU ,
  udif_application_challenge_password = 0x1CU , udif_application_challenge_password_failure = 0x1DU , udif_application_challenge_device_name = 0x1EU , udif_application_challenge_device_name_success = 0x1FU ,
  udif_application_challenge_device_name_failure = 0x20U , udif_application_remote_connect = 0x21U , udif_application_remote_connect_key = 0x22U , udif_application_remote_connect_success = 0x23U ,
  udif_application_remote_connect_failure = 0x24U , udif_application_socket_listen = 0x25U , udif_application_socket_listen_failure = 0x26U , udif_application_socket_listen_success = 0x27U ,
  udif_application_generate_key = 0x28U , udif_application_generate_key_failure = 0x29U , udif_application_generate_key_success = 0x2AU , udif_application_generate_key_overwrite = 0x2BU ,
  udif_application_operation_cancelled = 0x2CU , udif_application_client_enter_pubkey_path = 0x2DU , udif_application_client_pubkey_path_invalid = 0x2EU , udif_application_client_connection_success = 0x2FU ,
  udif_application_client_connection_failure = 0x30U , udif_application_address_invalid_format = 0x31U , udif_application_certificate_exists = 0x32U , udif_application_certificate_not_revoked = 0x33U ,
  udif_application_console_timeout_expired = 0x34U , udif_application_challenge_root_path = 0x35U , udif_application_challenge_root_path_success = 0x36U , udif_application_challenge_root_path_failure = 0x37U ,
  udif_application_root_copy_success = 0x38U , udif_application_root_copy_failure = 0x39U , udif_application_root_sign_failure = 0x3AU , udif_application_root_sign_success = 0x3BU ,
  udif_application_invalid_input = 0x3CU , udif_application_register_failure = 0x3DU , udif_application_register_success = 0x3EU , udif_application_register_existing = 0x3FU ,
  udif_application_announce_failure = 0x40U , udif_application_announce_success = 0x41U , udif_application_converge_failure = 0x42U , udif_application_converge_success = 0x43U ,
  udif_application_message_time_invalid = 0x44U , udif_application_certificate_not_found = 0x45U , udif_application_signature_failure = 0x46U , udif_application_network_resign_failure = 0x47U ,
  udif_application_network_resign_success = 0x48U , udif_application_certificate_revoke_failure = 0x49U , udif_application_certificate_revoke_success = 0x4AU , udif_application_address_change_failure = 0x4BU ,
  udif_application_address_change_success = 0x4CU , udif_application_address_change_challenge = 0x4DU , udif_application_address_change_current = 0x4EU , udif_application_address_change_message = 0x4FU ,
  udif_application_server_service_start_failure = 0x50U , udif_application_server_service_start_success = 0x51U , udif_application_server_service_stopped = 0x52U , udif_application_server_service_paused = 0x53U ,
  udif_application_server_service_resume_failure = 0x54U , udif_application_server_service_resume_success = 0x55U , udif_application_import_certificate_exists = 0x56U , udif_application_import_certificate_changed = 0x57U ,
  udif_application_import_certificate_failure = 0x58U , udif_application_import_certificate_success = 0x59U , udif_application_export_certificate_failure = 0x5AU , udif_application_export_certificate_success = 0x5BU ,
  udif_application_server_domain_change_challenge = 0x5CU , udif_application_server_domain_change_current = 0x5DU , udif_application_server_domain_change_failure = 0x5EU , udif_application_server_domain_change_success = 0x5FU ,
  udif_application_certificate_period_update = 0x60U , udif_application_certificate_root_validate = 0x61U , udif_application_command_not_supported = 0x62U , udif_application_network_ip_address_not_set = 0x63U ,
  udif_application_network_local_error = 0x64U , udif_application_network_remote_error = 0x65U , udif_application_topological_query_unknown = 0x66U , udif_application_topological_query_failure = 0x67U ,
  udif_application_topological_query_success = 0x68U , udif_application_adc_certificate_path_failure = 0x69U , udif_application_adc_certificate_path_success = 0x6AU , udif_application_adc_certificate_address_challenge = 0x6BU ,
  udif_application_adc_certificate_address_failure = 0x6CU , udif_application_server_backup_restore_challenge = 0x6DU , udif_application_server_backup_save_confirmation = 0x6EU , udif_application_certificate_remote_sign_failure = 0x6FU ,
  udif_application_certificate_remote_sign_success = 0x70U , udif_application_log_address_change = 0x71U , udif_application_log_domain_change = 0x72U , udif_application_log_hostname_change = 0x73U ,
  udif_application_log_user_logged_in = 0x74U , udif_application_log_log_created = 0x75U , udif_application_log_log_disabled = 0x76U , udif_application_log_log_enabled = 0x77U ,
  udif_application_log_log_header = 0x78U , udif_application_log_retries_change = 0x79U , udif_application_log_timeout_change = 0x7AU , udif_application_log_user_added = 0x7BU ,
  udif_application_log_state_restore = 0x7CU , udif_application_log_state_backup = 0x7DU , udif_application_log_service_paused = 0x7EU , udif_application_log_service_resumed = 0x7FU ,
  udif_application_log_service_started = 0x80U , udif_application_log_service_stopped = 0x81U , udif_application_log_mfk_exchange_failure = 0x82U , udif_application_log_mfk_exchange_success = 0x83U ,
  udif_application_log_generate_delete = 0x84U , udif_application_log_generate_failure = 0x85U , udif_application_log_generate_success = 0x86U , udif_application_log_revocation_failure = 0x87U ,
  udif_application_log_revocation_success = 0x88U , udif_application_log_convergence_failure = 0x89U , udif_application_log_convergence_success = 0x8AU , udif_application_log_incremental_failure = 0x8BU ,
  udif_application_log_incremental_success = 0x8CU , udif_application_log_allocation_failure = 0x8DU , udif_application_log_connection_terminated = 0x8EU , udif_application_log_configuration_erased = 0x8FU ,
  udif_application_log_receive_failure = 0x90U , udif_application_log_register_failure = 0x91U , udif_application_log_register_success = 0x92U , udif_application_log_fragment_exchange_failure = 0x93U ,
  udif_application_log_fragment_exchange_success = 0x94U , udif_application_log_local_resign_failure = 0x95U , udif_application_log_local_resign_success = 0x96U , udif_application_log_remote_invalid_request = 0x97U ,
  udif_application_log_remote_reported_error = 0x98U , udif_application_log_connect_failure = 0x99U , udif_application_log_connect_success = 0x9AU , udif_application_log_topology_node_query_failure = 0x9BU ,
  udif_application_log_topology_node_query_success = 0x9CU , udif_application_log_announce_failure = 0x9DU , udif_application_log_announce_success = 0x9EU , udif_application_log_remote_signing_failure = 0x9FU ,
  udif_application_log_remote_signing_success = 0xA0U , udif_application_log_remote_resign_failure = 0xA1U , udif_application_log_remote_resign_success = 0xA2U , udif_application_log_converge_node_remove_challenge = 0xA3U ,
  udif_application_ars_certificate_address_challenge = 0xA4U , udif_application_ars_certificate_address_failure = 0xA5U , udif_application_server_service_not_started = 0xA6U
}
 The ARS application messages. More...
enum  udif_command_actions {
  udif_command_action_none = 0x00U , udif_command_action_config_address = 0x01U , udif_command_action_config_certificate = 0x02U , udif_command_action_config_clear_all = 0x03U ,
  udif_command_action_config_clear_config = 0x04U , udif_command_action_config_clear_log = 0x05U , udif_command_action_config_exit = 0x06U , udif_command_action_config_help = 0x07U ,
  udif_command_action_config_log_host = 0x08U , udif_command_action_config_name_domain = 0x09U , udif_command_action_config_name_host = 0x0AU , udif_command_action_config_retries = 0x0BU ,
  udif_command_action_config_server = 0x0CU , udif_command_action_config_timeout = 0x0DU , udif_command_action_enable_clear_screen = 0x0EU , udif_command_action_enable_config = 0x0FU ,
  udif_command_action_enable_exit = 0x10U , udif_command_action_enable_help = 0x11U , udif_command_action_enable_quit = 0x12U , udif_command_action_enable_show_config = 0x13U ,
  udif_command_action_enable_show_log = 0x14U , udif_command_action_user_enable = 0x15U , udif_command_action_user_help = 0x16U , udif_command_action_user_quit = 0x17U ,
  udif_command_action_certificate_exit = 0x18U , udif_command_action_certificate_export = 0x19U , udif_command_action_certificate_generate = 0x1AU , udif_command_action_certificate_help = 0x1BU ,
  udif_command_action_certificate_import = 0x1CU , udif_command_action_certificate_print = 0x1DU , udif_command_action_server_backup = 0x1EU , udif_command_action_server_connect = 0x1FU ,
  udif_command_action_server_exit = 0x20U , udif_command_action_server_help = 0x21U , udif_command_action_server_list = 0x22U , udif_command_action_server_register = 0x23U ,
  udif_command_action_server_resign = 0x24U , udif_command_action_server_restore = 0x25U , udif_command_action_server_service = 0x26U , udif_command_action_server_query = 0x27U ,
  udif_command_action_client_connect_help = 0x28U , udif_command_action_client_connect_quit = 0x29U , udif_command_action_adc_certificate_revoke = 0x2AU , udif_command_action_adc_server_announce = 0x2BU ,
  udif_command_action_adc_server_converge = 0x2CU , udif_command_action_adc_server_revoke = 0x2DU , udif_command_action_adc_server_sproxy = 0x2EU , udif_command_action_certificate_sign = 0x2FU ,
  udif_command_action_config_clear = 0x30U , udif_command_action_config_log = 0x31U , udif_command_action_config_name = 0x32U , udif_command_action_help_enable_all = 0x33U ,
  udif_command_action_help_enable_show = 0x34U , udif_command_action_help_enable_user = 0x35U , udif_command_action_command_unrecognized = 0x36U
}
 The ARS command actions. More...
enum  udif_console_modes {
  udif_console_mode_name = 0x00U , udif_console_mode_user = 0x01U , udif_console_mode_enable = 0x02U , udif_console_mode_config = 0x03U ,
  udif_console_mode_certificate = 0x04U , udif_console_mode_server = 0x05U , udif_console_mode_login_message = 0x06U , udif_console_mode_login_password = 0x07U ,
  udif_console_mode_login_user = 0x08U , udif_console_mode_login_hostname = 0x09U , udif_console_mode_login_address = 0x0AU , udif_console_mode_login_domain = 0x0BU ,
  udif_console_mode_login_rootpath = 0x0CU , udif_console_mode_client_connected = 0x0DU
}
 The ARS console modes. More...

Detailed Description

The UDIF command enumerations.

Enumeration Type Documentation

◆ udif_application_messages

The ARS application messages.

Enumerator
udif_application_not_recognized 

The command was not recognized.

udif_application_erase_erase_all 

The system will be erased, including configuration and log files, do you want to proceed Y|N

udif_application_erase_config 

The user configuration will be erased, do you want to proceed Y|N"

udif_application_erase_log 

The log files will be erased, do you want to proceed Y|N

udif_application_authorization_failure 

The user is not authorized. Press any key to terminate the application.

udif_application_retries_exceeded 

Login has exceeded maximum retries. Press any key to terminate the application.

udif_application_application_quit 

The quit command has been entered. Press any key to terminate the application.

udif_application_logging_disabled 

Activity logging has been disabled.

udif_application_logging_enabled 

Activity logging has been enabled.

udif_application_authentication_failure 

User authentication has failed. Press any key to terminate the application.

udif_application_operation_aborted 

The operation was aborted by the user.

udif_application_system_erased 

System reset: The application log and configuration have been erased.

udif_application_configuration_erased 

System reset: The application log and configuration have been erased.

udif_application_log_erased 

The log file has been erased.

udif_application_retry_invalid 

The retry setting is invaid; valid retry range is between one and five [1-5] login attempts.

udif_application_timeout_invalid 

The timeout setting is invalid; valid timeout setting is between one and sixty [1-60] minutes.

udif_application_domain_invalid 

The domain name setting is invalid; valid domain name length is between two and thirty [2-32] characters.

udif_application_hostname_invalid 

The hostname setting is invalid; valid hostname length is between two and thirty [2-32] characters.

udif_application_configuration 

Printing configuration details:

udif_application_connection 

Printing connection details:

udif_application_connection_details 

minutes

udif_application_log_empty 

The log file is empty.

udif_application_first_login 

Running for the first time; please set the applications device name, username and password.

udif_application_choose_name 

Please choose a user name, minimum 6 characters, to a maximum 128 characters.

udif_application_choose_password 

Password must be 8-128 characters long [a-z, A-Z], at least 1 number, and 1 symbol [0-9][!#$&'()*+,_./].

udif_application_password_set 

The user name and password have been set.

udif_application_challenge_user 

Please enter the user name:

udif_application_challenge_user_failure 

The user name entered is not recognized.

udif_application_challenge_password 

Please enter the password:

udif_application_challenge_password_failure 

The password entered is invalid.

udif_application_challenge_device_name 

Please enter the device name, minimum 2 characters, to a maximum of 16 characters

udif_application_challenge_device_name_success 

The device name has been set.

udif_application_challenge_device_name_failure 

The device name is invalid.

udif_application_remote_connect 

Enter the IPv4 or IPv6 address of the host name.

udif_application_remote_connect_key 

No public key is associated with that address. Enter the encoded public key.

udif_application_remote_connect_success 

Connecting to the server...

udif_application_remote_connect_failure 

Connection attempt failed. The server is unreachable.

udif_application_socket_listen 

The host has entered server mode. Type quit to exit server mode.

udif_application_socket_listen_failure 

The listener failed to initialize. The host could not enter the listening state.

udif_application_socket_listen_success 

The listener has initialized: The server is now in the listening state.

udif_application_generate_key 

Generating the public/private signature key-pair.

udif_application_generate_key_failure 

The certificate could not be generated.

udif_application_generate_key_success 

The public key was saved to:

udif_application_generate_key_overwrite 

The signature key-pair already exists, do you want to overwite it? Y|N

udif_application_operation_cancelled 

The operation was cancelled by the user.

udif_application_client_enter_pubkey_path 

Enter the path to the remote hosts public key.

udif_application_client_pubkey_path_invalid 

Invalid path, could not find the hosts public key.

udif_application_client_connection_success 

Client connected to the remote host successfully.

udif_application_client_connection_failure 

Connection attempt failed! Could not connect to the remote server.

udif_application_address_invalid_format 

The IP address format was invalid! Enter a valid address format, ex. n.n.n.n

udif_application_certificate_exists 

Warning! The root certificate exists, do you want to overwite it? Y|N

udif_application_certificate_not_revoked 

Cannot delete an active certificate; revoke the certificate before deleting the file.

udif_application_console_timeout_expired 

The console timeout period has expired, set to user mode.

udif_application_challenge_root_path 

Enter the full path to the ARS root certificate.

udif_application_challenge_root_path_success 

The root certificate has been stored successfully.

udif_application_challenge_root_path_failure 

Could not find the certificate, or the file is invalid, please enter the path again.

udif_application_root_copy_success 

The root certificate has been copied successfully.

udif_application_root_copy_failure 

The root certificate could not be copied, check the path and permissions.

udif_application_root_sign_failure 

The certificate signing failed. The certificate was invalid or has incompatible parameters.

udif_application_root_sign_success 

The certificate was signed successfully.

udif_application_invalid_input 

The command input was invalid, operation failed.

udif_application_register_failure 

The network join request has failed, check the address.

udif_application_register_success 

The network join request has succeeded.

udif_application_register_existing 

The node is joined to an existing network, rejoin the ads? Y|N

udif_application_announce_failure 

The certificate has been announced to the network.

udif_application_announce_success 

The certificate announce operation has failed, check the path.

udif_application_converge_failure 

The topology update has failed, memory or signing failure.

udif_application_converge_success 

The topology update has been announced to the network.

udif_application_message_time_invalid 

The network time is invalid or has substantial delay.

udif_application_certificate_not_found 

The root, ads, or aps certificate could not be found.

udif_application_signature_failure 

The signature could not be generated for a message.

udif_application_network_resign_failure 

The network resign has failed, check the address.

udif_application_network_resign_success 

This node has resigned from the network.

udif_application_certificate_revoke_failure 

The certificate revocation has failed, check the path.

udif_application_certificate_revoke_success 

The certificate revocation has been broadcast to the network.

udif_application_address_change_failure 

The address is not routable, or not properly formed.

udif_application_address_change_success 

The server ip address has been changed, restart the server for changes to take effect.

udif_application_address_change_challenge 

Do you want to change the ip address? Y|N

udif_application_address_change_current 

The auto-detected ip address is:

udif_application_address_change_message 

Enter a routable IPv4 or IPv6 address.

udif_application_server_service_start_failure 

The server service could not be started, check for a valid signed certificate and network membership.

udif_application_server_service_start_success 

The server service was started successfully.

udif_application_server_service_stopped 

The server service has been stopped, use the command 'service start' to run.

udif_application_server_service_paused 

The server service has been paused, use the command 'service resume' to restart.

udif_application_server_service_resume_failure 

The server service could not be resumed, use the command 'service start' to run.

udif_application_server_service_resume_success 

The server service has resumed successfully.

udif_application_import_certificate_exists 

The server certificate already exists, do you want to replace it? Y|N

udif_application_import_certificate_changed 

Changing the server name or the domain name requires recreating the certificate, do you want to proceed? Y|N

udif_application_import_certificate_failure 

The server certificate could not be updated, check the path and root signature

udif_application_import_certificate_success 

The server certificate was updated successfully

udif_application_export_certificate_failure 

The server certificate could not be exported, check the path

udif_application_export_certificate_success 

The server certificate was exported successfully

udif_application_server_domain_change_challenge 

Do you want to change the servers domain name? Y|N

udif_application_server_domain_change_current 

The current domain name string:

udif_application_server_domain_change_failure 

The server could not update the domain name.

udif_application_server_domain_change_success 

The domain name has been updated successfully.

udif_application_certificate_period_update 

The days entered exceeds the root expiration period; days reduced to:

udif_application_certificate_root_validate 

The certificate must be signed by the ARS server before joining the network.

udif_application_command_not_supported 

The command is not supported on this server or version.

udif_application_network_ip_address_not_set 

The network address is invalid or not set.

udif_application_network_local_error 

received a network error from remote host:

udif_application_network_remote_error 

a network error occured with remote host:

udif_application_topological_query_unknown 

The query name format is invalid, valid format is domain.client

udif_application_topological_query_failure 

The device is offline or unknown to the ADC

udif_application_topological_query_success 

The device is online and available for connection

udif_application_adc_certificate_path_failure 

The certificate was not found or is not signed

udif_application_adc_certificate_path_success 

Provide the full path to the signed ADC certificate

udif_application_adc_certificate_address_challenge 

Provide the IP address of the ADC server

udif_application_adc_certificate_address_failure 

The ADC IP address format is invalid

udif_application_server_backup_restore_challenge 

Restore the configuration files from the last backup?

udif_application_server_backup_save_confirmation 

The configuration files have been backed up.

udif_application_certificate_remote_sign_failure 

The proxy service could not sign the certificate.

udif_application_certificate_remote_sign_success 

The certificate was signed by the proxy service.

udif_application_log_address_change 

The server address has been changed by the administrator

udif_application_log_domain_change 

The domain name was changed to

udif_application_log_hostname_change 

The host name was changed to

udif_application_log_user_logged_in 

Local user logged in:

udif_application_log_log_created 

Log file created:

udif_application_log_log_disabled 

Logging has been disabled on

udif_application_log_log_enabled 

Logging has been enabled on

udif_application_log_log_header 

UDIF version 1.0a, created September 2022.

udif_application_log_retries_change 

The login retries setting was changed to

udif_application_log_timeout_change 

The session timeout was changed to

udif_application_log_user_added 

Added user configuration:

udif_application_log_state_restore 

The server state has been restored

udif_application_log_state_backup 

The server state has been backed up

udif_application_log_service_paused 

The server service was paused

udif_application_log_service_resumed 

The server service was resumed

udif_application_log_service_started 

The server service was started

udif_application_log_service_stopped 

The server service was stopped

udif_application_log_mfk_exchange_failure 

The network mfk exchange has failed

udif_application_log_mfk_exchange_success 

The network mfk exchange has succeeded

udif_application_log_generate_delete 

The server generated a replacement certificate:

udif_application_log_generate_failure 

The certificate generation has failed.

udif_application_log_generate_success 

The certificate generation has succeeded:

udif_application_log_revocation_failure 

The certificate announcement has succeeded

udif_application_log_revocation_success 

The certificate revocation has failed

udif_application_log_convergence_failure 

The converce call has returned a failure

udif_application_log_convergence_success 

The remote host has converged and updated its certificate

udif_application_log_incremental_failure 

The topological update request failed or was denied

udif_application_log_incremental_success 

The topological update request was sent

udif_application_log_allocation_failure 

Memory allocation failure, connection aborted to host

udif_application_log_connection_terminated 

Connection terminated by remote host

udif_application_log_configuration_erased 

The configuration was erased by user:

udif_application_log_receive_failure 

The network session has timed out

udif_application_log_register_failure 

The network ads join request was denied

udif_application_log_register_success 

The network ads join request has succeeded

udif_application_log_fragment_exchange_failure 

The key fragment exchange has failed

udif_application_log_fragment_exchange_success 

The key fragment exchange has succeeded

udif_application_log_local_resign_failure 

The host resignation from the network failed

udif_application_log_local_resign_success 

The host has resigned from the network

udif_application_log_remote_invalid_request 

The remote device sent an invalid or unknown request

udif_application_log_remote_reported_error 

The remote device responded with an error code

udif_application_log_connect_failure 

Remote connection failed at

udif_application_log_connect_success 

Connected to remote host:

udif_application_log_topology_node_query_failure 

The node query failed

udif_application_log_topology_node_query_success 

The device answered a node query successfully

udif_application_log_announce_failure 

The node was not found in the topological database

udif_application_log_announce_success 

The certificate announcement has failed

udif_application_log_remote_signing_failure 

The remote certificate could not be signed

udif_application_log_remote_signing_success 

The remote certificate was signed successfully

udif_application_log_remote_resign_failure 

The remote host resignation from the network failed

udif_application_log_remote_resign_success 

The remote host has resigned from the network

udif_application_log_converge_node_remove_challenge 

Do you want to revoke this device and remove it from the database?

udif_application_ars_certificate_address_challenge 

Provide the IP address of the ARS server

udif_application_ars_certificate_address_failure 

The ARS IP address format is invalid

udif_application_server_service_not_started 

The server service must be started before issuing this command

◆ udif_command_actions

The ARS command actions.

Enumerator
udif_command_action_none 

unknown command

udif_command_action_config_address 

address [ip address] -Assign the server's network interface address; requires a restart.

udif_command_action_config_certificate 

crypto -enter the cryptographic command interface

udif_command_action_config_clear_all 

clear all -requires auth challenge, deletes everything

udif_command_action_config_clear_config 

clear config -requires auth challenge, deletes public key cache

udif_command_action_config_clear_log 

clear log -requires auth challenge, clears the logs

udif_command_action_config_exit 

exit -exits to enable mode

udif_command_action_config_help 

help for config mode

udif_command_action_config_log_host 

log [enable | disable] -log command and connection activity

udif_command_action_config_name_domain 

name domain [domain-name] -fully qualified domain-name

udif_command_action_config_name_host 

name host [host-name]

udif_command_action_config_retries 

retries [count] -authentication retries, default is 2

udif_command_action_config_server 

server -enter server configuration mode

udif_command_action_config_timeout 

timeout [seconds] -session default 120

udif_command_action_enable_clear_screen 

clear the screen

udif_command_action_enable_config 

config -enter configuration mode

udif_command_action_enable_exit 

exit -exits to user mode

udif_command_action_enable_help 

help for enable mode

udif_command_action_enable_quit 

quit -closes the application

udif_command_action_enable_show_config 

show config -show configuration

udif_command_action_enable_show_log 

show user log -show the user activity log

udif_command_action_user_enable 

enable -triggers authentication challenge

udif_command_action_user_help 

help -lists the help for user commands

udif_command_action_user_quit 

quit -closes the application

udif_command_action_certificate_exit 

exit -exits to config mode

udif_command_action_certificate_export 

export [path] -exports the local certificate to a file

udif_command_action_certificate_generate 

generate [period] -generate the public certificate

udif_command_action_certificate_help 

help -command help for certificate mode

udif_command_action_certificate_import 

import [path] -imports a certificate from a file

udif_command_action_certificate_print 

print -print a certificate

udif_command_action_server_backup 

backup -save a backup of the aps state

udif_command_action_server_connect 

connect [ip address] -connects to an application server or client

udif_command_action_server_exit 

exit -exits to config mode

udif_command_action_server_help 

help -command help for server mode

udif_command_action_server_list 

list -display the topological database

udif_command_action_server_register 

register [address] -register aps with the ADC

udif_command_action_server_resign 

resign [address] -resign from the ADC

udif_command_action_server_restore 

restore -restore the device state from backup

udif_command_action_server_service 

service -[start | stop | pause | resume] the server service

udif_command_action_server_query 

query [canonical-name] -Request node information for a device from the ADC

udif_command_action_client_connect_help 

help -command help for connect mode

udif_command_action_client_connect_quit 

quit -quits the remote server connection

udif_command_action_adc_certificate_revoke 

revoke [certificate path] -revoke the local device certificate

udif_command_action_adc_server_announce 

announce [certificate-path, ip-address] -announce an aps to servers in the network

udif_command_action_adc_server_converge 

converge -announce a topology update to the network

udif_command_action_adc_server_revoke 

revoke [certificate path] -revoke an aps's credentials by announcing it to the network

udif_command_action_adc_server_sproxy 

sproxy [certificate path] -send a remote certificate signing request to the ARS server

udif_command_action_certificate_sign 

sign [certificate path] -sign a child certificate

udif_command_action_config_clear 

clear the configuration

udif_command_action_config_log 

print the configuration log

udif_command_action_config_name 

get the configuration name

udif_command_action_help_enable_all 

enable all mode help

udif_command_action_help_enable_show 

enable show mode help

udif_command_action_help_enable_user 

enable user mode help

udif_command_action_command_unrecognized 

the command was unrecognized

◆ udif_console_commands

The common console functions.

Enumerator
udif_commands_none 

No command is recognized

udif_commands_certificate_create 

Create a new root certificate

udif_commands_certificate_change 

Broadcast a root certificate change

udif_commands_certificate_sign 

Sign a device certificate

udif_commands_certificate_revoke 

Broadcast a certificate revocation

udif_commands_certificate_format 

Convert a certificate to a readable string

udif_commands_device_add 

Add a device to the UDIF network

udif_commands_network_converge 

Broadcast a network reconvergence event

udif_commands_adc_election 

Broadcast a ADC election

◆ udif_console_modes

The ARS console modes.

Enumerator
udif_console_mode_name 

The name prompt

udif_console_mode_user 

The user mode prompt

udif_console_mode_enable 

The enable mode prompt

udif_console_mode_config 

The config mode prompt

udif_console_mode_certificate 

The certificate mode prompt

udif_console_mode_server 

The server mode prompt

udif_console_mode_login_message 

The login message

udif_console_mode_login_password 

The login password message

udif_console_mode_login_user 

The login user name message

udif_console_mode_login_hostname 

The login host name message

udif_console_mode_login_address 

The login address message

udif_console_mode_login_domain 

The login domain name message

udif_console_mode_login_rootpath 

The login root path message

udif_console_mode_client_connected 

The client is connected to a remore server