# Struct ipworksiot::CoAP An easy-to-use CoAP client and server implementation. ## Syntax ```text ipworksiot::CoAP ``` ## Remarks The CoAP struct provides a lightweight, fully-featured CoAP client and server implementation with DTLS support. ### Using the Struct in Client Mode While in client mode (i.e., the [listening](#listening-property-coap-struct) property is disabled; its default setting), the struct can be used to send requests to a CoAP server. It can also be used to register as an observer for various server-side resources, causing the server to send notifications anytime said resources change. By default, the component operates in NoSec mode as defined by RFC 7252. Certificate mode DTLS can be enabled by setting [ssl_enabled](#ssl_enabled-property-coap-struct) to *True*. [UseRawPublicKey](#UseRawPublicKey) can be used to enable Raw Public Key mode. When DTLS is enabled, relevant handshake details will be reported by the [on_ssl_status](#on_ssl_status-event-coap-struct) event. Initially, the server will present its certificate to the client. The certificate is validated by the system and the status is provided within the [on_ssl_server_authentication](#on_ssl_server_authentication-event-coap-struct) event. If the *Accept* parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-coap-struct) event is false, the *Status* parameter will tell you why. You can then set the *Accept* parameter to true to manually force acceptance of the server certificate. In some cases, the server requires the client to present a certificate as well. In this case, a valid certificate will need to be specified via the ssl_cert property. This process may look like the following: ```csharp coapclient.OnSSLServerAuthentication += (o, e) => { if (e.Accept) return; Console.Write("Server provided the following certificate:\nIssuer: " + e.CertIssuer + "\nSubject: " + e.CertSubject + "\n"); Console.Write("The following problems have been determined for this certificate: " + e.Status + "\n"); Console.Write("Would you like to accept anyways? [y/n] "); if (Console.Read() == 'y') e.Accept = true; }; coapclient.SSLEnabled = true; coapclient.RemoteHost = "remote_ip"; coapclient.RemotePort = 1234; coapclient.Timeout = 30; // if client authentication is applicable coapclient.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject"); ``` To send a request, populate the [request_data](#request_data-property-coap-struct), [request_content_format](#request_content_format-property-coap-struct), [request_e_tag](#request_e_tag-property-coap-struct), and request_options properties (if necessary, and as applicable), then call one of the following methods: - [get](#get-method-coap-struct) - [post](#post-method-coap-struct) - [put](#put-method-coap-struct) - [delete](#delete-method-coap-struct) - [send_custom_request](#send_custom_request-method-coap-struct) The methods above require a URI as a parameter. The format of the *URI* parameter is *coap://hostname:port/resource*. The port is optional, and if not specified will default to 5683. For instance *coap://myserver/test* and *coap://myserver:5683/test* are equivalent. Once a response is received, the [response_code](#response_code-property-coap-struct), [response_data](#response_data-property-coap-struct), [response_content_format](#response_content_format-property-coap-struct), [response_e_tag](#response_e_tag-property-coap-struct), and response_options properties will be populated, and the [on_request_complete](#on_request_complete-event-coap-struct) event will fire. (If the request times out, the properties are not populated, but the event still fires.) ```csharp coap.OnRequestComplete += (s, e) => { Console.WriteLine("Request complete!"); Console.WriteLine(coap.ResponseCode); }; // Make a GET request to download a picture. coap.Get("coap://mycoapserver/pictures/animals/cats4.dat?format=png"); // Imaginary function which accepts PNG image data and displays the picture to the user. showPicture(coap.ResponseDataB); ``` To observe a resource, call the [start_observing](#start_observing-method-coap-struct) method. Assuming the server accepts the observer registration request, it will begin sending notifications for the resource anytime it changes. Each change notification will cause the [response_code](#response_code-property-coap-struct), [response_data](#response_data-property-coap-struct), [response_content_format](#response_content_format-property-coap-struct), [response_e_tag](#response_e_tag-property-coap-struct), and response_options properties to be populated, and the [on_notification](#on_notification-event-coap-struct) event to fire. To stop observing a resource, either call [stop_observing](#stop_observing-method-coap-struct) with the same *URI* value used to call [start_observing](#start_observing-method-coap-struct), or set the [on_notification](#on_notification-event-coap-struct) event's *StopObserving* parameter to *True*. ```csharp coap.OnNotification += (s, e) => { // Notifications can arrive out of order; only print to the log if this is the latest one we've received. if (e.IsLatest) { Console.WriteLine("Received notification for the resource at: " + e.URI); Console.WriteLine("New Value: " + coap.ResponseData); } } // Start observing a temperature sensor's data. Assume temperature values are sent back in text format. coap.StartObserving("coap://mycoapserver/home/living_room/sensors/temperature?unit=fahrenheit"); // Assume the server accepts the request and starts sending notifications every so often. // ... // Later, stop observing the resource. coap.StopObserving("coap://mycoapserver/home/living_room/sensors/temperature?unit=fahrenheit"); ``` ### Using the Struct in Server Mode To operate in server mode, set the [local_port](#local_port-property-coap-struct) to the port the struct should listen on (typically *5683*, the standard CoAP port), then enable the [listening](#listening-property-coap-struct) property. Each time a request arrives, the [request_data](#request_data-property-coap-struct), [request_content_format](#request_content_format-property-coap-struct), [request_e_tag](#request_e_tag-property-coap-struct), and request_options properties will be populated, and the [on_request](#on_request-event-coap-struct) event will fire. By default, the component operates in NoSec mode as defined by RFC 7252. Certificate mode DTLS can be enabled by setting [ssl_enabled](#ssl_enabled-property-coap-struct) to *True*. [UseRawPublicKey](#UseRawPublicKey) can be used to enable Raw Public Key mode. When DTLS is enabled, a valid certificate must be selected before the server can start listening for incoming connections. The certificate can be specified via the ssl_cert property. Note the certificate must contain a private key. After doing so, calling [start_listening](#start_listening-method-coap-struct) will cause the struct to start listening for incoming connections. The struct will listen on the interface defined by [local_host](#local_host-property-coap-struct) and [local_port](#local_port-property-coap-struct), if specified. Otherwise, these values will be set by the struct. If applicable, these values must be set before calling [start_listening](#start_listening-method-coap-struct). For example: ```csharp //coapserver.LocalHost = "some_ip_address"; //coapserver.LocalPort = 1234; coapserver.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject"); coapserver.StartListening(); Console.WriteLine("Listening on: " + coapserver.LocalHost + ":" + coapserver.LocalPort); while (coapserver.Listening) { coapserver.DoEvents(); } ``` A response can be sent by populating the [response_code](#response_code-property-coap-struct), [response_data](#response_data-property-coap-struct), [response_content_format](#response_content_format-property-coap-struct), [response_e_tag](#response_e_tag-property-coap-struct), and response_options properties as desired before the event finishes. Alternatively, the [on_request](#on_request-event-coap-struct) event's *SendResponse* parameter can be set to *False* in order to send a response back later. In this case, the *RequestId* value from the event should be used to call the [send_response](#send_response-method-coap-struct) method later. ```csharp coap.OnRequest += (s, e) => { // For the purpose of this snippet, assume we only service GET requests, which have a method code of 1. if (e.Method == 1) { Console.WriteLine("GET request received for URI path: " + e.URIPath + " and URI query params: " + e.URIQuery); coap.ResponseCode = "2.05"; // "Content". // Imaginary methods that look up the data and content format of the resource based on the URI path and URI query parameters. coap.ResponseData = lookupResourceData(e.URIPath, e.URIQuery); coap.ResponseContentFormat = lookupResourceContentFormat(e.URIPath, e.URIQuery); } else { coap.ResponseCode = "4.05"; // "Method Not Allowed". coap.ResponseData = "Only GET requests are allowed."; // Include a diagnostic payload. coap.ResponseContentFormat = ""; } // Alternatively, this event could simply save the e.RequestId value somewhere, then some other code could fill in the Response* // properties and call the SendResponse() method later. }; coap.OnResponseComplete += (s, e) => { Console.WriteLine("Response sent for request with Id " + e.RequestId); }; ``` In server mode, the struct can also support resource observation. When a client attempts to register itself as an observer of a resource, the [on_register](#on_register-event-coap-struct) event will fire; setting this event's *Accept* parameter to *True* will cause the struct to accept the registration. To notify clients that a resource has changed, populate the [response_code](#response_code-property-coap-struct), [response_data](#response_data-property-coap-struct), [response_content_format](#response_content_format-property-coap-struct), [response_e_tag](#response_e_tag-property-coap-struct), and response_options properties as desired, and then call the [send_notification](#send_notification-method-coap-struct) method, passing it the URI of a resource that has registered observers. When a client has unregistered from further change notifications, the [on_unregistered](#on_unregistered-event-coap-struct) event will fire. ```csharp coap.OnRegister += (s, e) => { Console.WriteLine("Client " + e.RemoteHost + ":" + e.RemotePort + " has registered for notifications for the URI " + e.URI); // Imaginary method that helps ensure the application keeps track of observed URIs. The struct itself maintains the // list of observers for each URI, so the application just needs to know that there are observers in the first place. observerRegisteredForURI(e.URI); e.Accept = true; }; coap.OnUnregistered += (s, e) => { Console.WriteLine("Client " + e.RemoteHost + ":" + e.RemotePort + " has unregistered from notifications for the URI " + e.URI); // As above, imaginary method that helps ensure the application keeps track of observed URIs. observerUnregisteredForURI(e.URI); }; // Somewhere else in the application, this sort of code might get called after a resource changes to inform any observers of // the change. We use another imaginary method here to check if the changed resource is observed, and to get its information. if (isResourceObserved()) { coap.ResponseCode = "2.05"; // "Content". coap.ResponseDataB = getResourceContent(); coap.ResponseContentFormat = getResourceContentFormat(); coap.SendNotification(getResourceURI()); } ``` ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksIoT. Due to this, the CoAP struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of CoAP when you have finished using the instance. ## Property List *The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [listening](#listening-property-coap-struct) | Whether the struct should operate in server mode by listening for incoming requests. | | [local_host](#local_host-property-coap-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [local_port](#local_port-property-coap-struct) | This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds. | | [pending_request_count](#pending_request_count-property-coap-struct) | The number of records in the PendingRequest arrays. | | [pending_request_method](#pending_request_method-property-coap-struct) | The request's method. | | [pending_request_remote_host](#pending_request_remote_host-property-coap-struct) | The remote host associated with the request. | | [pending_request_remote_port](#pending_request_remote_port-property-coap-struct) | The remote port associated with the request. | | [pending_request_id](#pending_request_id-property-coap-struct) | The request's Id. | | [pending_request_token](#pending_request_token-property-coap-struct) | The request's token. | | [pending_request_uri](#pending_request_uri-property-coap-struct) | The request URI. | | [request_content_format](#request_content_format-property-coap-struct) | The request content format. | | [request_data](#request_data-property-coap-struct) | The request data. | | [request_e_tag](#request_e_tag-property-coap-struct) | The request ETag. | | [request_option_count](#request_option_count-property-coap-struct) | The number of records in the RequestOption arrays. | | [request_option_critical](#request_option_critical-property-coap-struct) | Whether the option is critical. | | [request_option_no_cache_key](#request_option_no_cache_key-property-coap-struct) | Whether the option is to be excluded from the cache-key. | | [request_option_number](#request_option_number-property-coap-struct) | The option's number. | | [request_option_unsafe](#request_option_unsafe-property-coap-struct) | Whether the option is unsafe to forward. | | [request_option_value](#request_option_value-property-coap-struct) | The option's value. | | [request_option_value_type](#request_option_value_type-property-coap-struct) | The option's value data type. | | [response_code](#response_code-property-coap-struct) | The response code. | | [response_content_format](#response_content_format-property-coap-struct) | The response content format. | | [response_data](#response_data-property-coap-struct) | The response data. | | [response_e_tag](#response_e_tag-property-coap-struct) | The response ETag. | | [response_option_count](#response_option_count-property-coap-struct) | The number of records in the ResponseOption arrays. | | [response_option_critical](#response_option_critical-property-coap-struct) | Whether the option is critical. | | [response_option_no_cache_key](#response_option_no_cache_key-property-coap-struct) | Whether the option is to be excluded from the cache-key. | | [response_option_number](#response_option_number-property-coap-struct) | The option's number. | | [response_option_unsafe](#response_option_unsafe-property-coap-struct) | Whether the option is unsafe to forward. | | [response_option_value](#response_option_value-property-coap-struct) | The option's value. | | [response_option_value_type](#response_option_value_type-property-coap-struct) | The option's value data type. | | [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property-coap-struct) | The date on which this certificate becomes valid. | | [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property-coap-struct) | The date on which the certificate expires. | | [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property-coap-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property-coap-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property-coap-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property-coap-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property-coap-struct) | The issuer of the certificate. | | [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-coap-struct) | The private key of the certificate (if available). | | [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-coap-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property-coap-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property-coap-struct) | The public key of the certificate. | | [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property-coap-struct) | The textual description of the certificate's public key algorithm. | | [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property-coap-struct) | The length of the certificate's public key (in bits). | | [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property-coap-struct) | The serial number of the certificate encoded as a string. | | [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property-coap-struct) | The text description of the certificate's signature algorithm. | | [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-coap-struct) | The name of the certificate store for the client certificate. | | [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-coap-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-coap-struct) | The type of certificate store for this certificate. | | [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property-coap-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property-coap-struct) | The MD5 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property-coap-struct) | The SHA-1 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property-coap-struct) | The SHA-256 hash of the certificate. | | [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-coap-struct) | The text description of UsageFlags . | | [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-coap-struct) | The flags that show intended use for the certificate. | | [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property-coap-struct) | The certificate's version number. | | [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-coap-struct) | The subject of the certificate used for client authentication. | | [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-coap-struct) | The certificate (PEM/Base64 encoded). | | [ssl_authenticate_clients](#ssl_authenticate_clients-property-coap-struct) | If set to True, the server asks the client(s) for a certificate. | | [ssl_cert_effective_date](#ssl_cert_effective_date-property-coap-struct) | The date on which this certificate becomes valid. | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property-coap-struct) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property-coap-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property-coap-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property-coap-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property-coap-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property-coap-struct) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property-coap-struct) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-coap-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property-coap-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property-coap-struct) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property-coap-struct) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property-coap-struct) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property-coap-struct) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property-coap-struct) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property-coap-struct) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#ssl_cert_store_password-property-coap-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_cert_store_type](#ssl_cert_store_type-property-coap-struct) | The type of certificate store for this certificate. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property-coap-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property-coap-struct) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property-coap-struct) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property-coap-struct) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property-coap-struct) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-coap-struct) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property-coap-struct) | The certificate's version number. | | [ssl_cert_subject](#ssl_cert_subject-property-coap-struct) | The subject of the certificate used for client authentication. | | [ssl_cert_encoded](#ssl_cert_encoded-property-coap-struct) | The certificate (PEM/Base64 encoded). | | [ssl_enabled](#ssl_enabled-property-coap-struct) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property-coap-struct) | The date on which this certificate becomes valid. | | [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property-coap-struct) | The date on which the certificate expires. | | [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property-coap-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property-coap-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property-coap-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property-coap-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_server_cert_issuer](#ssl_server_cert_issuer-property-coap-struct) | The issuer of the certificate. | | [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-coap-struct) | The private key of the certificate (if available). | | [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-coap-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property-coap-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_server_cert_public_key](#ssl_server_cert_public_key-property-coap-struct) | The public key of the certificate. | | [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property-coap-struct) | The textual description of the certificate's public key algorithm. | | [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property-coap-struct) | The length of the certificate's public key (in bits). | | [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property-coap-struct) | The serial number of the certificate encoded as a string. | | [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property-coap-struct) | The text description of the certificate's signature algorithm. | | [ssl_server_cert_store](#ssl_server_cert_store-property-coap-struct) | The name of the certificate store for the client certificate. | | [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-coap-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-coap-struct) | The type of certificate store for this certificate. | | [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property-coap-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property-coap-struct) | The MD5 hash of the certificate. | | [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property-coap-struct) | The SHA-1 hash of the certificate. | | [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property-coap-struct) | The SHA-256 hash of the certificate. | | [ssl_server_cert_usage](#ssl_server_cert_usage-property-coap-struct) | The text description of UsageFlags . | | [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-coap-struct) | The flags that show intended use for the certificate. | | [ssl_server_cert_version](#ssl_server_cert_version-property-coap-struct) | The certificate's version number. | | [ssl_server_cert_subject](#ssl_server_cert_subject-property-coap-struct) | The subject of the certificate used for client authentication. | | [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-coap-struct) | The certificate (PEM/Base64 encoded). | | [timeout](#timeout-property-coap-struct) | A timeout for the struct. | | [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) | Whether to use confirmable message. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [cancel_request](#cancel_request-method-coap-struct) | Cancels a pending request. | | [config](#config-method-coap-struct) | Sets or retrieves a configuration setting. | | [delete](#delete-method-coap-struct) | Sends a DELETE request to the server. | | [do_events](#do_events-method-coap-struct) | This method processes events from the internal message queue. | | [get](#get-method-coap-struct) | Sends a GET request to the server. | | [post](#post-method-coap-struct) | Sends a POST request to the server. | | [put](#put-method-coap-struct) | Sends a PUT request to the server. | | [reset](#reset-method-coap-struct) | This method will reset the struct. | | [send_custom_request](#send_custom_request-method-coap-struct) | Sends a custom request to the server. | | [send_notification](#send_notification-method-coap-struct) | Sends a notification to all clients observing a given resource. | | [send_response](#send_response-method-coap-struct) | Sends a response for a given pending request to the corresponding client. | | [start_listening](#start_listening-method-coap-struct) | This method starts listening for incoming connections. | | [start_observing](#start_observing-method-coap-struct) | Registers the struct as an observer for a given resource. | | [stop_listening](#stop_listening-method-coap-struct) | This method stops listening for new connections. | | [stop_observing](#stop_observing-method-coap-struct) | Unregisters the struct as an observer for a given resource. | ## Event List *The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_error](#on_error-event-coap-struct) | Fired when information is available about errors during data delivery. | | [on_log](#on_log-event-coap-struct) | Fires once for each log message. | | [on_notification](#on_notification-event-coap-struct) | Fires when a notification is received from the server. | | [on_register](#on_register-event-coap-struct) | Fires when a client wishes to register for notifications. | | [on_request](#on_request-event-coap-struct) | Fires when a request is received from a client. | | [on_request_complete](#on_request_complete-event-coap-struct) | Fires when a request completes. | | [on_response_complete](#on_response_complete-event-coap-struct) | Fires when a response has been sent to a client. | | [on_ssl_client_authentication](#on_ssl_client_authentication-event-coap-struct) | This event is fired when the client presents its credentials to the server. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event-coap-struct) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event-coap-struct) | Fired when secure connection progress messages are available. | | [on_unregistered](#on_unregistered-event-coap-struct) | Fires when a client has unregistered from notifications. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [MessageId](#MessageId) | Sets the MessageId for a request. | | [UseEmptyToken](#UseEmptyToken) | Uses an empty value for the request token. | | [UseRawPublicKey](#UseRawPublicKey) | Whether to enable Raw Public Key mode. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. | | [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. | | [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. | | [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the struct binds. | | [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. | | [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). | | [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). | | [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the struct to be active on the same local port. | | [UseConnection](#UseConnection) | Determines whether to use a connected socket. | | [UseIPv6](#UseIPv6) | Whether or not to use IPv6. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # listening property ([CoAP](#struct-ipworksiotcoap) Struct) Whether the struct should operate in server mode by listening for incoming requests. ## Syntax *Rust Syntax* ```text fn listening(&self ) -> Result ``` ## Default Value false ## Remarks This property indicates whether the struct operates in server mode or client mode. When this property is *false* (default), the struct operate in client mode, allowing applications to send requests using the [get](#get-method-coap-struct), [post](#post-method-coap-struct), [send_custom_request](#send_custom_request-method-coap-struct), etc. methods. When this property is *true*, the struct listens on [local_port](#local_port-property-coap-struct) for incoming CoAP requests, firing the [on_request](#on_request-event-coap-struct) event anytime one arrives. Applications can service these requests directly during [on_request](#on_request-event-coap-struct) events, or send separate responses later using the [send_response](#send_response-method-coap-struct) method. Applications that wish to use the struct in server mode should set the [local_port](#local_port-property-coap-struct) property to the desired listening port (such as *5683*, the standard CoAP port) *before* calling [start_listening](#start_listening-method-coap-struct). Otherwise the system will choose a port at random. Use the [start_listening](#start_listening-method-coap-struct) and [stop_listening](#stop_listening-method-coap-struct) methods to control whether the struct is listening. This property is read-only. ## Data Type bool # local_host property ([CoAP](#struct-ipworksiotcoap) Struct) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Rust Syntax* ```text fn local_host(&self ) -> Result fn set_local_host(&self, value : &str) -> Option fn set_local_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: local_host is not persistent. You must always set it in code, and never in the property window. ## Data Type String # local_port property ([CoAP](#struct-ipworksiotcoap) Struct) This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds. ## Syntax *Rust Syntax* ```text fn local_port(&self ) -> Result fn set_local_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The local_port property must be set before UDP is activated (active is set to True). This instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting it to *0* (default) enables the Transmission Control Protocol (TCP)/IP stack to choose a port at random. The chosen port will be shown by the local_port property after the connection is established. local_port cannot be changed once the struct is active. Any attempt to set the local_port property when the struct is active will generate an error. The local_port property is useful when trying to connect to services that require a trusted port on the client side. ## Data Type i32 # pending_request_count property ([CoAP](#struct-ipworksiotcoap) Struct) The number of records in the PendingRequest arrays. ## Syntax *Rust Syntax* ```text fn pending_request_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [pending_request_id](#pending_request_id-property-coap-struct) - [pending_request_method](#pending_request_method-property-coap-struct) - [pending_request_remote_host](#pending_request_remote_host-property-coap-struct) - [pending_request_remote_port](#pending_request_remote_port-property-coap-struct) - [pending_request_token](#pending_request_token-property-coap-struct) - [pending_request_uri](#pending_request_uri-property-coap-struct) The array indices start at *0* and end at *pending_request_count - 1*. This property is read-only. ## Data Type i32 # pending_request_method property ([CoAP](#struct-ipworksiotcoap) Struct) The request's method. ## Syntax *Rust Syntax* ```text fn pending_request_method(&self , PendingRequestIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The request's method. This property reflects the request's method code, which must be a value in the range *0* to *31*. The following table provides a (non-exhaustive) list of some of the more common method codes; refer to the IANA's [CoAP Method Codes](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#method-codes) registry for a full list. | Method Code | Name | | --- | --- | | 1 | GET | | 2 | POST | | 3 | PUT | | 4 | DELETE | | 5 | FETCH | | 6 | PATCH | The *PendingRequestIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PendingRequestCount](#pending_request_count-property-coap-struct) property. This property is read-only. ## Data Type i32 # pending_request_remote_host property ([CoAP](#struct-ipworksiotcoap) Struct) The remote host associated with the request. ## Syntax *Rust Syntax* ```text fn pending_request_remote_host(&self , PendingRequestIndex : i32) -> Result ``` ## Default Value "" ## Remarks The remote host associated with the request. This property reflects the remote host associated with the request. When the struct is operating in client mode (i.e., the listening property is disabled), this is the remote host to which the request was sent; when the struct is operating in server mode (i.e., the listening property is enabled), this is the remote host from which the request was received. The *PendingRequestIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PendingRequestCount](#pending_request_count-property-coap-struct) property. This property is read-only. ## Data Type String # pending_request_remote_port property ([CoAP](#struct-ipworksiotcoap) Struct) The remote port associated with the request. ## Syntax *Rust Syntax* ```text fn pending_request_remote_port(&self , PendingRequestIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The remote port associated with the request. This property reflects the remote port associated with the request. Refer to the [pending_request_remote_host](#pending_request_remote_host-property-coap-struct) property's documentation for more information. The *PendingRequestIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PendingRequestCount](#pending_request_count-property-coap-struct) property. This property is read-only. ## Data Type i32 # pending_request_id property ([CoAP](#struct-ipworksiotcoap) Struct) The request's Id. ## Syntax *Rust Syntax* ```text fn pending_request_id(&self , PendingRequestIndex : i32) -> Result ``` ## Default Value "" ## Remarks The request's Id. This property reflects the request's struct-generated Id. The *PendingRequestIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PendingRequestCount](#pending_request_count-property-coap-struct) property. This property is read-only. ## Data Type String # pending_request_token property ([CoAP](#struct-ipworksiotcoap) Struct) The request's token. ## Syntax *Rust Syntax* ```text fn pending_request_token(&self , PendingRequestIndex : i32) -> Result, IPWorksIoTError> ``` ## Default Value "" ## Remarks The request's token. This property reflects the request's token. The *PendingRequestIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PendingRequestCount](#pending_request_count-property-coap-struct) property. This property is read-only. ## Data Type Vec # pending_request_uri property ([CoAP](#struct-ipworksiotcoap) Struct) The request URI. ## Syntax *Rust Syntax* ```text fn pending_request_uri(&self , PendingRequestIndex : i32) -> Result ``` ## Default Value "" ## Remarks The request URI. This property reflects the request's URI. The *PendingRequestIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PendingRequestCount](#pending_request_count-property-coap-struct) property. This property is read-only. ## Data Type String # request_content_format property ([CoAP](#struct-ipworksiotcoap) Struct) The request content format. ## Syntax *Rust Syntax* ```text fn request_content_format(&self ) -> Result fn set_request_content_format(&self, value : i32) -> Option ``` ## Default Value -1 ## Remarks When the struct is operating in client mode (i.e., the [listening](#listening-property-coap-struct) property is disabled), this property specifies the content format that should be included in outgoing requests. When the struct is operating in server mode (i.e., the [listening](#listening-property-coap-struct) property is enabled), this property is populated with the content format included in incoming requests (if any) anytime the [on_request](#on_request-event-coap-struct) event fires. In either case, the valid set of values for this property is *-1*, or a value in the range *0* to *65535*. *-1* prevents a Content-Format option from being included when sending a request, or indicates that one was not included in a received response. The following table provides a (non-exhaustive) list of some of the more common content formats; refer to the IANA's [CoAP Content-Formats](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats) registry for a full list. | | | | | --- | --- | --- | | -1 (default) | Content-Format option not included. | | | Value | Media Type | Encoding | | 0 | text/plain; charset=utf-8 | | | 40 | application/link-format | | | 41 | application/xml | | | 42 | application/octet-stream | | | 47 | application/exi | | | 50 | application/json | | | 51 | application/json-patch+json | | | 52 | application/merge-patch+json | | | 60 | application/cbor | | | 61 | application/cwt | | | 62 | application/multipart-core | | | 63 | application/cbor-seq | | | 11050 | application/json | deflate | | 11060 | application/cbor | deflate | ## Data Type i32 # request_data property ([CoAP](#struct-ipworksiotcoap) Struct) The request data. ## Syntax *Rust Syntax* ```text fn request_data(&self ) -> Result, IPWorksIoTError> fn set_request_data(&self, value : Vec) -> Option fn set_request_data_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks When the struct is operating in client mode (i.e., the [listening](#listening-property-coap-struct) property is disabled), this property specifies the data that should be included in requests sent using [post](#post-method-coap-struct), [put](#put-method-coap-struct), or [send_custom_request](#send_custom_request-method-coap-struct). When the struct is operating in server mode (i.e., the [listening](#listening-property-coap-struct) property is enabled), this property is populated with the data included in incoming requests (if any) anytime the [on_request](#on_request-event-coap-struct) event fires. ## Data Type Vec # request_e_tag property ([CoAP](#struct-ipworksiotcoap) Struct) The request ETag. ## Syntax *Rust Syntax* ```text fn request_e_tag(&self ) -> Result, IPWorksIoTError> fn set_request_e_tag(&self, value : Vec) -> Option fn set_request_e_tag_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks When the struct is operating in client mode (i.e., the [listening](#listening-property-coap-struct) property is disabled), this property specifies the ETag that should be included in outgoing requests. Leave it empty to prevent an Etag option from being included. When the struct is operating in server mode (i.e., the [listening](#listening-property-coap-struct) property is enabled), this property is populated with the ETag included in incoming requests (if any) anytime the [on_request](#on_request-event-coap-struct) event fires. It will be empty if an Etag option was not included. ## Data Type Vec # request_option_count property ([CoAP](#struct-ipworksiotcoap) Struct) The number of records in the RequestOption arrays. ## Syntax *Rust Syntax* ```text fn request_option_count(&self ) -> Result fn set_request_option_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [request_option_critical](#request_option_critical-property-coap-struct) - [request_option_no_cache_key](#request_option_no_cache_key-property-coap-struct) - [request_option_number](#request_option_number-property-coap-struct) - [request_option_unsafe](#request_option_unsafe-property-coap-struct) - [request_option_value](#request_option_value-property-coap-struct) - [request_option_value_type](#request_option_value_type-property-coap-struct) The array indices start at *0* and end at *request_option_count - 1*. ## Data Type i32 # request_option_critical property ([CoAP](#struct-ipworksiotcoap) Struct) Whether the option is critical. ## Syntax *Rust Syntax* ```text fn request_option_critical(&self , RequestOptionIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether the option is critical. This property reflects whether the option is critical or elective. Receivers that do not recognize a critical option must return a *4.02* "Bad Option" response code back to the sender. Unrecognized elective options can be safely ignored. The *RequestOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RequestOptionCount](#request_option_count-property-coap-struct) property. This property is read-only. ## Data Type bool # request_option_no_cache_key property ([CoAP](#struct-ipworksiotcoap) Struct) Whether the option is to be excluded from the cache-key. ## Syntax *Rust Syntax* ```text fn request_option_no_cache_key(&self , RequestOptionIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether the option is to be excluded from the cache-key. This property reflects whether the option should be excluded from any cache-key calculations. This information is generally only needed for caching and proxying. The *RequestOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RequestOptionCount](#request_option_count-property-coap-struct) property. This property is read-only. ## Data Type bool # request_option_number property ([CoAP](#struct-ipworksiotcoap) Struct) The option's number. ## Syntax *Rust Syntax* ```text fn request_option_number(&self , RequestOptionIndex : i32) -> Result fn set_request_option_number(&self, RequestOptionIndex : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks The option's number. The property reflects the option's number, which must be a value in the range *0* to *65535* (inclusive). Setting this property to a recognized option number (see table below) will automatically set the [request_option_value_type](#request_option_value_type-property-coap-struct) property to the correct value (it should be set manually otherwise). The following table provides a (non-exhaustive) list of some of the more common option numbers; refer to the IANA's [CoAP Option Numbers](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#option-numbers) registry for a full list. | Number | Option | | --- | --- | | 1 | If-Match | | 3 | Uri-Host | | 4 | ETag | | 5 | If-None-Match | | 6 | Observe | | 7 | Uri-Port | | 8 | Location-Path | | 11 | Uri-Path | | 12 | Content-Format | | 14 | Max-Age | | 15 | Uri-Query | | 17 | Accept | | 20 | Location-Query | | 23 | Block2 | | 27 | Block1 | | 35 | Proxy-Uri | | 39 | Proxy-Scheme | | 60 | Size1 | The *RequestOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RequestOptionCount](#request_option_count-property-coap-struct) property. ## Data Type i32 # request_option_unsafe property ([CoAP](#struct-ipworksiotcoap) Struct) Whether the option is unsafe to forward. ## Syntax *Rust Syntax* ```text fn request_option_unsafe(&self , RequestOptionIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether the option is unsafe to forward. This property reflects whether the option is unsafe to forward. This information is generally only needed for proxying. The *RequestOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RequestOptionCount](#request_option_count-property-coap-struct) property. This property is read-only. ## Data Type bool # request_option_value property ([CoAP](#struct-ipworksiotcoap) Struct) The option's value. ## Syntax *Rust Syntax* ```text fn request_option_value(&self , RequestOptionIndex : i32) -> Result fn set_request_option_value(&self, RequestOptionIndex : i32, value : &str) -> Option fn set_request_option_value_ref(&self, RequestOptionIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The option's value. This property specifies the option's value. The [request_option_value_type](#request_option_value_type-property-coap-struct) property specifies the data type of the value. The *RequestOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RequestOptionCount](#request_option_count-property-coap-struct) property. ## Data Type String # request_option_value_type property ([CoAP](#struct-ipworksiotcoap) Struct) The option's value data type. ## Syntax *Rust Syntax* ```text fn request_option_value_type(&self , RequestOptionIndex : i32) -> Result fn set_request_option_value_type(&self, RequestOptionIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // String1 // UInt2 // Binary ``` ## Default Value 0 ## Remarks The option's value data type. This property specifies the data type of the option's [request_option_value](#request_option_value-property-coap-struct). If [request_option_number](#request_option_number-property-coap-struct) is set to a recognized value (refer to the table in its documentation), this property will automatically be set to the correct value. The table below shows the possible value types, their descriptions, and how to format the data assigned to [request_option_value](#request_option_value-property-coap-struct). | Type | Description | Value Format | | --- | --- | --- | | ovtString (0) (default) | String | String | | ovtUInt (1) | Unsigned integer | 0 to 4294967295 | | ovtBinary (2) | Binary data | Hex-encoded byte string | The *RequestOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RequestOptionCount](#request_option_count-property-coap-struct) property. ## Data Type i32 # response_code property ([CoAP](#struct-ipworksiotcoap) Struct) The response code. ## Syntax *Rust Syntax* ```text fn response_code(&self ) -> Result fn set_response_code(&self, value : &str) -> Option fn set_response_code_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks When the struct is operating in client mode (i.e., the [listening](#listening-property-coap-struct) property is disabled), this property is populated with the response code included in incoming responses anytime the [on_request_complete](#on_request_complete-event-coap-struct) event fires. When the struct is operating in server mode (i.e., the [listening](#listening-property-coap-struct) property is enabled), this property specifies the response code that should be included in outgoing responses (regardless of whether they are sent immediately after [on_request](#on_request-event-coap-struct) fires, or later using [send_response](#send_response-method-coap-struct) or [send_notification](#send_notification-method-coap-struct)). In either case, the valid set of values for this property are strings of the format *c.dd*, where *c* is a class value in the range *2* to *7*, and *dd* is a detail value in the range *00* to *31*. The following table provides a (non-exhaustive) list of some of the more common response codes; refer to the IANA's [CoAP Response Codes](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#response-codes) registry for a full list. | Code | Description | | --- | --- | | 2.01 | Created | | 2.02 | Deleted | | 2.03 | Valid | | 2.04 | Changed | | 2.05 | Content | | 2.31 | Continue | | 4.00 | Bad Request | | 4.01 | Unauthorized | | 4.02 | Bad Option | | 4.03 | Forbidden | | 4.04 | Not Found | | 4.12 | Precondition Failed | | 5.00 | Internal Server Error | | 5.01 | Not Implemented | | 5.02 | Bad Gateway | | 5.03 | Service Unavailable | | 5.04 | Gateway Timeout | ## Data Type String # response_content_format property ([CoAP](#struct-ipworksiotcoap) Struct) The response content format. ## Syntax *Rust Syntax* ```text fn response_content_format(&self ) -> Result fn set_response_content_format(&self, value : i32) -> Option ``` ## Default Value -1 ## Remarks When the struct is operating in client mode (i.e., the [listening](#listening-property-coap-struct) property is disabled), this property is populated with the content format included in incoming responses anytime the [on_request_complete](#on_request_complete-event-coap-struct) event fires. When the struct is operating in server mode (i.e., the [listening](#listening-property-coap-struct) property is enabled), this property specifies the content format that should be included in outgoing responses (regardless of whether they are sent immediately after [on_request](#on_request-event-coap-struct) fires, or later using [send_response](#send_response-method-coap-struct) or [send_notification](#send_notification-method-coap-struct)). In either case, the valid set of values for this property is *-1*, or a value in the range *0* to *65535*. *-1* prevents a Content-Format option from being included when sending a response, or indicates that one was not included in a received response. The following table provides a (non-exhaustive) list of some of the more common content formats; refer to the IANA's [CoAP Content-Formats](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats) registry for a full list. | | | | | --- | --- | --- | | -1 (default) | Content-Format option not included. | | | Value | Media Type | Encoding | | 0 | text/plain; charset=utf-8 | | | 40 | application/link-format | | | 41 | application/xml | | | 42 | application/octet-stream | | | 47 | application/exi | | | 50 | application/json | | | 51 | application/json-patch+json | | | 52 | application/merge-patch+json | | | 60 | application/cbor | | | 61 | application/cwt | | | 62 | application/multipart-core | | | 63 | application/cbor-seq | | | 11050 | application/json | deflate | | 11060 | application/cbor | deflate | ## Data Type i32 # response_data property ([CoAP](#struct-ipworksiotcoap) Struct) The response data. ## Syntax *Rust Syntax* ```text fn response_data(&self ) -> Result, IPWorksIoTError> fn set_response_data(&self, value : Vec) -> Option fn set_response_data_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks When the struct is operating in client mode (i.e., the [listening](#listening-property-coap-struct) property is disabled), this property is populated with the data included in incoming responses (if any) anytime the [on_request_complete](#on_request_complete-event-coap-struct) event fires. When the struct is operating in server mode (i.e., the [listening](#listening-property-coap-struct) property is enabled), this property specifies the data that should be included in outgoing responses (regardless of whether they are sent immediately after [on_request](#on_request-event-coap-struct) fires, or later using [send_response](#send_response-method-coap-struct) or [send_notification](#send_notification-method-coap-struct)). ## Data Type Vec # response_e_tag property ([CoAP](#struct-ipworksiotcoap) Struct) The response ETag. ## Syntax *Rust Syntax* ```text fn response_e_tag(&self ) -> Result, IPWorksIoTError> fn set_response_e_tag(&self, value : Vec) -> Option fn set_response_e_tag_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks When the struct is operating in client mode (i.e., the [listening](#listening-property-coap-struct) property is disabled), this property is populated with the ETag included in incoming responses (if any) anytime the [on_request_complete](#on_request_complete-event-coap-struct) event fires. It will be empty if an Etag option was not included. When the struct is operating in server mode (i.e., the [listening](#listening-property-coap-struct) property is enabled), this property specifies the ETag that should be included in outgoing responses (regardless of whether they are sent immediately after [on_request](#on_request-event-coap-struct) fires, or later using [send_response](#send_response-method-coap-struct) or [send_notification](#send_notification-method-coap-struct)). Leave it empty to prevent an Etag option from being included. ## Data Type Vec # response_option_count property ([CoAP](#struct-ipworksiotcoap) Struct) The number of records in the ResponseOption arrays. ## Syntax *Rust Syntax* ```text fn response_option_count(&self ) -> Result fn set_response_option_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [response_option_critical](#response_option_critical-property-coap-struct) - [response_option_no_cache_key](#response_option_no_cache_key-property-coap-struct) - [response_option_number](#response_option_number-property-coap-struct) - [response_option_unsafe](#response_option_unsafe-property-coap-struct) - [response_option_value](#response_option_value-property-coap-struct) - [response_option_value_type](#response_option_value_type-property-coap-struct) The array indices start at *0* and end at *response_option_count - 1*. ## Data Type i32 # response_option_critical property ([CoAP](#struct-ipworksiotcoap) Struct) Whether the option is critical. ## Syntax *Rust Syntax* ```text fn response_option_critical(&self , ResponseOptionIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether the option is critical. This property reflects whether the option is critical or elective. Receivers that do not recognize a critical option must return a *4.02* "Bad Option" response code back to the sender. Unrecognized elective options can be safely ignored. The *ResponseOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResponseOptionCount](#response_option_count-property-coap-struct) property. This property is read-only. ## Data Type bool # response_option_no_cache_key property ([CoAP](#struct-ipworksiotcoap) Struct) Whether the option is to be excluded from the cache-key. ## Syntax *Rust Syntax* ```text fn response_option_no_cache_key(&self , ResponseOptionIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether the option is to be excluded from the cache-key. This property reflects whether the option should be excluded from any cache-key calculations. This information is generally only needed for caching and proxying. The *ResponseOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResponseOptionCount](#response_option_count-property-coap-struct) property. This property is read-only. ## Data Type bool # response_option_number property ([CoAP](#struct-ipworksiotcoap) Struct) The option's number. ## Syntax *Rust Syntax* ```text fn response_option_number(&self , ResponseOptionIndex : i32) -> Result fn set_response_option_number(&self, ResponseOptionIndex : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks The option's number. The property reflects the option's number, which must be a value in the range *0* to *65535* (inclusive). Setting this property to a recognized option number (see table below) will automatically set the [response_option_value_type](#response_option_value_type-property-coap-struct) property to the correct value (it should be set manually otherwise). The following table provides a (non-exhaustive) list of some of the more common option numbers; refer to the IANA's [CoAP Option Numbers](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#option-numbers) registry for a full list. | Number | Option | | --- | --- | | 1 | If-Match | | 3 | Uri-Host | | 4 | ETag | | 5 | If-None-Match | | 6 | Observe | | 7 | Uri-Port | | 8 | Location-Path | | 11 | Uri-Path | | 12 | Content-Format | | 14 | Max-Age | | 15 | Uri-Query | | 17 | Accept | | 20 | Location-Query | | 23 | Block2 | | 27 | Block1 | | 35 | Proxy-Uri | | 39 | Proxy-Scheme | | 60 | Size1 | The *ResponseOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResponseOptionCount](#response_option_count-property-coap-struct) property. ## Data Type i32 # response_option_unsafe property ([CoAP](#struct-ipworksiotcoap) Struct) Whether the option is unsafe to forward. ## Syntax *Rust Syntax* ```text fn response_option_unsafe(&self , ResponseOptionIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether the option is unsafe to forward. This property reflects whether the option is unsafe to forward. This information is generally only needed for proxying. The *ResponseOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResponseOptionCount](#response_option_count-property-coap-struct) property. This property is read-only. ## Data Type bool # response_option_value property ([CoAP](#struct-ipworksiotcoap) Struct) The option's value. ## Syntax *Rust Syntax* ```text fn response_option_value(&self , ResponseOptionIndex : i32) -> Result fn set_response_option_value(&self, ResponseOptionIndex : i32, value : &str) -> Option fn set_response_option_value_ref(&self, ResponseOptionIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The option's value. This property specifies the option's value. The [response_option_value_type](#response_option_value_type-property-coap-struct) property specifies the data type of the value. The *ResponseOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResponseOptionCount](#response_option_count-property-coap-struct) property. ## Data Type String # response_option_value_type property ([CoAP](#struct-ipworksiotcoap) Struct) The option's value data type. ## Syntax *Rust Syntax* ```text fn response_option_value_type(&self , ResponseOptionIndex : i32) -> Result fn set_response_option_value_type(&self, ResponseOptionIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // String1 // UInt2 // Binary ``` ## Default Value 0 ## Remarks The option's value data type. This property specifies the data type of the option's [response_option_value](#response_option_value-property-coap-struct). If [response_option_number](#response_option_number-property-coap-struct) is set to a recognized value (refer to the table in its documentation), this property will automatically be set to the correct value. The table below shows the possible value types, their descriptions, and how to format the data assigned to [response_option_value](#response_option_value-property-coap-struct). | Type | Description | Value Format | | --- | --- | --- | | ovtString (0) (default) | String | String | | ovtUInt (1) | Unsigned integer | 0 to 4294967295 | | ovtBinary (2) | Binary data | Hex-encoded byte string | The *ResponseOptionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResponseOptionCount](#response_option_count-property-coap-struct) property. ## Data Type i32 # ssl_accept_server_cert_effective_date property ([CoAP](#struct-ipworksiotcoap) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_effective_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # ssl_accept_server_cert_expiration_date property ([CoAP](#struct-ipworksiotcoap) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_expiration_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # ssl_accept_server_cert_extended_key_usage property ([CoAP](#struct-ipworksiotcoap) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # ssl_accept_server_cert_fingerprint property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # ssl_accept_server_cert_fingerprint_sha1 property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # ssl_accept_server_cert_fingerprint_sha256 property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # ssl_accept_server_cert_issuer property ([CoAP](#struct-ipworksiotcoap) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_issuer(&self ) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # ssl_accept_server_cert_private_key property ([CoAP](#struct-ipworksiotcoap) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-coap-struct) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-coap-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_accept_server_cert_private_key_available property ([CoAP](#struct-ipworksiotcoap) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-coap-struct) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-coap-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # ssl_accept_server_cert_private_key_container property ([CoAP](#struct-ipworksiotcoap) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-coap-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ssl_accept_server_cert_public_key property ([CoAP](#struct-ipworksiotcoap) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # ssl_accept_server_cert_public_key_algorithm property ([CoAP](#struct-ipworksiotcoap) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssl_accept_server_cert_public_key_length property ([CoAP](#struct-ipworksiotcoap) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssl_accept_server_cert_serial_number property ([CoAP](#struct-ipworksiotcoap) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_serial_number(&self ) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # ssl_accept_server_cert_signature_algorithm property ([CoAP](#struct-ipworksiotcoap) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssl_accept_server_cert_store property ([CoAP](#struct-ipworksiotcoap) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_store(&self ) -> Result, IPWorksIoTError> fn set_ssl_accept_server_cert_store(&self, value : Vec) -> Option fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-coap-struct) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-coap-struct). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-coap-struct). [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-coap-struct) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-coap-struct) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-coap-struct) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-coap-struct) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-coap-struct) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-coap-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type Vec # ssl_accept_server_cert_store_password property ([CoAP](#struct-ipworksiotcoap) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_store_password(&self ) -> Result fn set_ssl_accept_server_cert_store_password(&self, value : &str) -> Option fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # ssl_accept_server_cert_store_type property ([CoAP](#struct-ipworksiotcoap) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_store_type(&self ) -> Result fn set_ssl_accept_server_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-coap-struct), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-coap-struct), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-coap-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-coap-struct) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-coap-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # ssl_accept_server_cert_subject_alt_names property ([CoAP](#struct-ipworksiotcoap) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ssl_accept_server_cert_thumbprint_md5 property ([CoAP](#struct-ipworksiotcoap) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_accept_server_cert_thumbprint_sha1 property ([CoAP](#struct-ipworksiotcoap) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_accept_server_cert_thumbprint_sha256 property ([CoAP](#struct-ipworksiotcoap) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_accept_server_cert_usage property ([CoAP](#struct-ipworksiotcoap) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-coap-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # ssl_accept_server_cert_usage_flags property ([CoAP](#struct-ipworksiotcoap) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-coap-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-coap-struct) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-coap-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssl_accept_server_cert_version property ([CoAP](#struct-ipworksiotcoap) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ssl_accept_server_cert_subject property ([CoAP](#struct-ipworksiotcoap) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_subject(&self ) -> Result fn set_ssl_accept_server_cert_subject(&self, value : &str) -> Option fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # ssl_accept_server_cert_encoded property ([CoAP](#struct-ipworksiotcoap) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_encoded(&self ) -> Result, IPWorksIoTError> fn set_ssl_accept_server_cert_encoded(&self, value : Vec) -> Option fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-coap-struct) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-coap-struct) properties also may be used to specify a certificate. When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-coap-struct) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-coap-struct) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-coap-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-coap-struct) is set to an empty string. ## Data Type Vec # ssl_authenticate_clients property ([CoAP](#struct-ipworksiotcoap) Struct) If set to True, the server asks the client(s) for a certificate. ## Syntax *Rust Syntax* ```text fn ssl_authenticate_clients(&self ) -> Result fn set_ssl_authenticate_clients(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property is used in conjunction with the [on_ssl_client_authentication](#on_ssl_client_authentication-event-coap-struct) event. Please refer to the documentation of the [on_ssl_client_authentication](#on_ssl_client_authentication-event-coap-struct) event for details. ## Data Type bool # ssl_cert_effective_date property ([CoAP](#struct-ipworksiotcoap) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_cert_effective_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # ssl_cert_expiration_date property ([CoAP](#struct-ipworksiotcoap) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_cert_expiration_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # ssl_cert_extended_key_usage property ([CoAP](#struct-ipworksiotcoap) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_cert_extended_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # ssl_cert_fingerprint property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # ssl_cert_fingerprint_sha1 property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # ssl_cert_fingerprint_sha256 property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # ssl_cert_issuer property ([CoAP](#struct-ipworksiotcoap) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_issuer(&self ) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # ssl_cert_private_key property ([CoAP](#struct-ipworksiotcoap) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_cert_private_key](#ssl_cert_private_key-property-coap-struct) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property-coap-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_cert_private_key_available property ([CoAP](#struct-ipworksiotcoap) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property-coap-struct) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-coap-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # ssl_cert_private_key_container property ([CoAP](#struct-ipworksiotcoap) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property-coap-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ssl_cert_public_key property ([CoAP](#struct-ipworksiotcoap) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # ssl_cert_public_key_algorithm property ([CoAP](#struct-ipworksiotcoap) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssl_cert_public_key_length property ([CoAP](#struct-ipworksiotcoap) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssl_cert_serial_number property ([CoAP](#struct-ipworksiotcoap) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_cert_serial_number(&self ) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # ssl_cert_signature_algorithm property ([CoAP](#struct-ipworksiotcoap) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_cert_signature_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssl_cert_store property ([CoAP](#struct-ipworksiotcoap) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_store(&self ) -> Result, IPWorksIoTError> fn set_ssl_cert_store(&self, value : Vec) -> Option fn set_ssl_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property-coap-struct) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property-coap-struct). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property-coap-struct). [ssl_cert_store](#ssl_cert_store-property-coap-struct) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property-coap-struct) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property-coap-struct) has a value, and [ssl_cert_subject](#ssl_cert_subject-property-coap-struct) or [ssl_cert_encoded](#ssl_cert_encoded-property-coap-struct) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property-coap-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type Vec # ssl_cert_store_password property ([CoAP](#struct-ipworksiotcoap) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn ssl_cert_store_password(&self ) -> Result fn set_ssl_cert_store_password(&self, value : &str) -> Option fn set_ssl_cert_store_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # ssl_cert_store_type property ([CoAP](#struct-ipworksiotcoap) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_store_type(&self ) -> Result fn set_ssl_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property-coap-struct), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property-coap-struct), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property-coap-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property-coap-struct) and set [ssl_cert_store_password](#ssl_cert_store_password-property-coap-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # ssl_cert_subject_alt_names property ([CoAP](#struct-ipworksiotcoap) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ssl_cert_thumbprint_md5 property ([CoAP](#struct-ipworksiotcoap) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_md5(&self ) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_cert_thumbprint_sha1 property ([CoAP](#struct-ipworksiotcoap) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_cert_thumbprint_sha256 property ([CoAP](#struct-ipworksiotcoap) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_cert_usage property ([CoAP](#struct-ipworksiotcoap) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-coap-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # ssl_cert_usage_flags property ([CoAP](#struct-ipworksiotcoap) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-coap-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_cert_usage](#ssl_cert_usage-property-coap-struct) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-coap-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssl_cert_version property ([CoAP](#struct-ipworksiotcoap) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_cert_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ssl_cert_subject property ([CoAP](#struct-ipworksiotcoap) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_cert_subject(&self ) -> Result fn set_ssl_cert_subject(&self, value : &str) -> Option fn set_ssl_cert_subject_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # ssl_cert_encoded property ([CoAP](#struct-ipworksiotcoap) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_cert_encoded(&self ) -> Result, IPWorksIoTError> fn set_ssl_cert_encoded(&self, value : Vec) -> Option fn set_ssl_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property-coap-struct) and [ssl_cert_subject](#ssl_cert_subject-property-coap-struct) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property-coap-struct) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property-coap-struct) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property-coap-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property-coap-struct) is set to an empty string. ## Data Type Vec # ssl_enabled property ([CoAP](#struct-ipworksiotcoap) Struct) This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax *Rust Syntax* ```text fn ssl_enabled(&self ) -> Result fn set_ssl_enabled(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting ssl_start_mode. Setting ssl_start_mode will automatically update this property value. ## Data Type bool # ssl_server_cert_effective_date property ([CoAP](#struct-ipworksiotcoap) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_effective_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # ssl_server_cert_expiration_date property ([CoAP](#struct-ipworksiotcoap) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_expiration_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # ssl_server_cert_extended_key_usage property ([CoAP](#struct-ipworksiotcoap) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_extended_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # ssl_server_cert_fingerprint property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # ssl_server_cert_fingerprint_sha1 property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # ssl_server_cert_fingerprint_sha256 property ([CoAP](#struct-ipworksiotcoap) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # ssl_server_cert_issuer property ([CoAP](#struct-ipworksiotcoap) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_issuer(&self ) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # ssl_server_cert_private_key property ([CoAP](#struct-ipworksiotcoap) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-coap-struct) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-coap-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_server_cert_private_key_available property ([CoAP](#struct-ipworksiotcoap) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-coap-struct) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-coap-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # ssl_server_cert_private_key_container property ([CoAP](#struct-ipworksiotcoap) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-coap-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ssl_server_cert_public_key property ([CoAP](#struct-ipworksiotcoap) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # ssl_server_cert_public_key_algorithm property ([CoAP](#struct-ipworksiotcoap) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssl_server_cert_public_key_length property ([CoAP](#struct-ipworksiotcoap) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssl_server_cert_serial_number property ([CoAP](#struct-ipworksiotcoap) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_serial_number(&self ) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # ssl_server_cert_signature_algorithm property ([CoAP](#struct-ipworksiotcoap) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_signature_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssl_server_cert_store property ([CoAP](#struct-ipworksiotcoap) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_store(&self ) -> Result, IPWorksIoTError> ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-coap-struct) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property-coap-struct). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-coap-struct). [ssl_server_cert_store](#ssl_server_cert_store-property-coap-struct) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property-coap-struct) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property-coap-struct) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property-coap-struct) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-coap-struct) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property-coap-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). This property is read-only. ## Data Type Vec # ssl_server_cert_store_password property ([CoAP](#struct-ipworksiotcoap) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_store_password(&self ) -> Result ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. This property is read-only. ## Data Type String # ssl_server_cert_store_type property ([CoAP](#struct-ipworksiotcoap) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_store_type(&self ) -> Result ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-coap-struct), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property-coap-struct), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-coap-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_server_cert_store](#ssl_server_cert_store-property-coap-struct) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-coap-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | This property is read-only. ## Data Type i32 # ssl_server_cert_subject_alt_names property ([CoAP](#struct-ipworksiotcoap) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ssl_server_cert_thumbprint_md5 property ([CoAP](#struct-ipworksiotcoap) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_md5(&self ) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_server_cert_thumbprint_sha1 property ([CoAP](#struct-ipworksiotcoap) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_server_cert_thumbprint_sha256 property ([CoAP](#struct-ipworksiotcoap) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssl_server_cert_usage property ([CoAP](#struct-ipworksiotcoap) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_server_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-coap-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # ssl_server_cert_usage_flags property ([CoAP](#struct-ipworksiotcoap) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-coap-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_server_cert_usage](#ssl_server_cert_usage-property-coap-struct) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-coap-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssl_server_cert_version property ([CoAP](#struct-ipworksiotcoap) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ssl_server_cert_subject property ([CoAP](#struct-ipworksiotcoap) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_subject(&self ) -> Result ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. This property is read-only. ## Data Type String # ssl_server_cert_encoded property ([CoAP](#struct-ipworksiotcoap) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_encoded(&self ) -> Result, IPWorksIoTError> ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property-coap-struct) and [ssl_server_cert_subject](#ssl_server_cert_subject-property-coap-struct) properties also may be used to specify a certificate. When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-coap-struct) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property-coap-struct) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property-coap-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property-coap-struct) is set to an empty string. This property is read-only. ## Data Type Vec # timeout property ([CoAP](#struct-ipworksiotcoap) Struct) A timeout for the struct. ## Syntax *Rust Syntax* ```text fn timeout(&self ) -> Result fn set_timeout(&self, value : i32) -> Option ``` ## Default Value 60 ## Remarks This property specifies the number of seconds that the struct should wait, synchronously, for a response to be received. A value of *0* means that the struct will send the request data (when operating in client mode) or the response data (when operating in server mode) asynchronously, and then wait indefinitely, firing the applicable event once complete. The struct will use [do_events](#do_events-method-coap-struct) to enter an efficient wait loop during any potential waiting period, ensuring that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive. If timeout expires, and the response has not yet been received, the struct throws an exception. ## Data Type i32 # use_confirmable_messages property ([CoAP](#struct-ipworksiotcoap) Struct) Whether to use confirmable message. ## Syntax *Rust Syntax* ```text fn use_confirmable_messages(&self ) -> Result fn set_use_confirmable_messages(&self, value : bool) -> Option ``` ## Default Value true ## Remarks This property specifies whether the struct should send requests (if operating in client mode; i.e., when the [listening](#listening-property-coap-struct) property is disabled) or responses (if operating in server mode; i.e., when the [listening](#listening-property-coap-struct) property is enabled) using confirmable messages instead of unconfirmable messages. Using confirmable messages increases reliability, since the struct will automatically retransmit a message until it receives a confirmation from the remote host that the message was received. Note that the retransmission period is not infinite; eventually the struct will assume that the message is undeliverable and time out the retransmission process. Using non-confirmable messages reduces the amount of network traffic, but at the cost of reliability, since the struct has no way to know whether a given message was received by the remote host, or lost in transit. ## Data Type bool # cancel_request method ([CoAP](#struct-ipworksiotcoap) Struct) Cancels a pending request. ## Syntax *Rust Syntax* ```text fn cancel_request(&self, request_id : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method cancels the request in the pending_requests properties identified by *RequestId*. When the struct is operating in client mode, the requests in the pending_requests properties represent outgoing requests for which responses have not yet been received. Canceling one will cause the [on_request_complete](#on_request_complete-event-coap-struct) event to fire with an appropriate *ErrorCode* and *ErrorDescription*. When the struct is operating in server mode, the requests in the pending_requests properties represent incoming requests for which responses have not yet been sent. Canceling one will cause the [on_response_complete](#on_response_complete-event-coap-struct) event to fire with an appropriate *ErrorCode* and *ErrorDescription*. # config method ([CoAP](#struct-ipworksiotcoap) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-coap-struct) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-coap-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # delete method ([CoAP](#struct-ipworksiotcoap) Struct) Sends a DELETE request to the server. ## Syntax *Rust Syntax* ```text fn delete(&self, uri : &str) -> Result ``` ## Remarks This method sends the server a DELETE request for the resource identified by *URI*. If the [request_e_tag](#request_e_tag-property-coap-struct) property is non-empty, its value will be used to include an Etag option in the request. Any additional options present in the request_options properties will be included as well. The format of the *URI* parameter is *coap://hostname:port/resource*. The port is optional, and if not specified will default to 5683. For instance *coap://myserver/test* and *coap://myserver:5683/test* are equivalent. If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled when this method is called, the struct will automatically retransmit the request message (if necessary) until it receives confirmation from the server that it was received. Note that the retransmission period is not infinite; eventually the struct will assume that the message is undeliverable and time out the request. If the [timeout](#timeout-property-coap-struct) property is greater than *0*, this method will block until either a response is received, the specified timeout interval elapses, or (if [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string. If the [timeout](#timeout-property-coap-struct) property is *0*, a record of the request will be added to the pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the [cancel_request](#cancel_request-method-coap-struct) method will cancel the request (assuming it is still pending at that time). Once a response is received, or the request times out, the struct will do the following: - Populate the **Response*** properties (unless the request timed out). - Remove the request record from the pending_requests properties, if necessary. - Fire the [on_request_complete](#on_request_complete-event-coap-struct) event. Note: This method can only be called when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # do_events method ([CoAP](#struct-ipworksiotcoap) Struct) This method processes events from the internal message queue. ## Syntax *Rust Syntax* ```text fn do_events(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # get method ([CoAP](#struct-ipworksiotcoap) Struct) Sends a GET request to the server. ## Syntax *Rust Syntax* ```text fn get(&self, uri : &str) -> Result ``` ## Remarks This method sends the server a GET request for the resource identified by *URI*. If the [request_e_tag](#request_e_tag-property-coap-struct) property is non-empty, its value will be used to include an Etag option in the request. Any additional options present in the request_options properties will be included as well. The format of the *URI* parameter is *coap://hostname:port/resource*. The port is optional, and if not specified will default to 5683. For instance *coap://myserver/test* and *coap://myserver:5683/test* are equivalent. If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled when this method is called, the struct will automatically retransmit the request message (if necessary) until it receives confirmation from the server that it was received. Note that the retransmission period is not infinite; eventually the struct will assume that the message is undeliverable and time out the request. If the [timeout](#timeout-property-coap-struct) property is greater than *0*, this method will block until either a response is received, the specified timeout interval elapses, or (if [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string. If the [timeout](#timeout-property-coap-struct) property is *0*, a record of the request will be added to the pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the [cancel_request](#cancel_request-method-coap-struct) method will cancel the request (assuming it is still pending at that time). Once a response is received, or the request times out, the struct will do the following: - Populate the **Response*** properties (unless the request timed out). - Remove the request record from the pending_requests properties, if necessary. - Fire the [on_request_complete](#on_request_complete-event-coap-struct) event. Note: This method can only be called when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # post method ([CoAP](#struct-ipworksiotcoap) Struct) Sends a POST request to the server. ## Syntax *Rust Syntax* ```text fn post(&self, uri : &str) -> Result ``` ## Remarks This method sends the server a POST request for the resource identified by *URI*. The [request_data](#request_data-property-coap-struct) property specifies the data that will be sent in the request. If the [request_content_format](#request_content_format-property-coap-struct) and/or [request_e_tag](#request_e_tag-property-coap-struct) properties are non-empty, their values will be used to include Content-Format and Etag options in the request (respectively). Any additional options present in the request_options properties will be included as well. The format of the *URI* parameter is *coap://hostname:port/resource*. The port is optional, and if not specified will default to 5683. For instance *coap://myserver/test* and *coap://myserver:5683/test* are equivalent. If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled when this method is called, the struct will automatically retransmit the request message (if necessary) until it receives confirmation from the server that it was received. Note that the retransmission period is not infinite; eventually the struct will assume that the message is undeliverable and time out the request. If the [timeout](#timeout-property-coap-struct) property is greater than *0*, this method will block until either a response is received, the specified timeout interval elapses, or (if [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string. If the [timeout](#timeout-property-coap-struct) property is *0*, a record of the request will be added to the pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the [cancel_request](#cancel_request-method-coap-struct) method will cancel the request (assuming it is still pending at that time). Once a response is received, or the request times out, the struct will do the following: - Populate the **Response*** properties (unless the request timed out). - Remove the request record from the pending_requests properties, if necessary. - Fire the [on_request_complete](#on_request_complete-event-coap-struct) event. Note: This method can only be called when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # put method ([CoAP](#struct-ipworksiotcoap) Struct) Sends a PUT request to the server. ## Syntax *Rust Syntax* ```text fn put(&self, uri : &str) -> Result ``` ## Remarks This method sends the server a PUT request for the resource identified by *URI*. The [request_data](#request_data-property-coap-struct) property specifies the data that will be sent in the request. If the [request_content_format](#request_content_format-property-coap-struct) and/or [request_e_tag](#request_e_tag-property-coap-struct) properties are non-empty, their values will be used to include Content-Format and Etag options in the request (respectively). Any additional options present in the request_options properties will be included as well. The format of the *URI* parameter is *coap://hostname:port/resource*. The port is optional, and if not specified will default to 5683. For instance *coap://myserver/test* and *coap://myserver:5683/test* are equivalent. If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled when this method is called, the struct will automatically retransmit the request message (if necessary) until it receives confirmation from the server that it was received. Note that the retransmission period is not infinite; eventually the struct will assume that the message is undeliverable and time out the request. If the [timeout](#timeout-property-coap-struct) property is greater than *0*, this method will block until either a response is received, the specified timeout interval elapses, or (if [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string. If the [timeout](#timeout-property-coap-struct) property is *0*, a record of the request will be added to the pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the [cancel_request](#cancel_request-method-coap-struct) method will cancel the request (assuming it is still pending at that time). Once a response is received, or the request times out, the struct will do the following: - Populate the **Response*** properties (unless the request timed out). - Remove the request record from the pending_requests properties, if necessary. - Fire the [on_request_complete](#on_request_complete-event-coap-struct) event. Note: This method can only be called when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # reset method ([CoAP](#struct-ipworksiotcoap) Struct) This method will reset the struct. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks This method will reset the struct's properties to their default values. # send_custom_request method ([CoAP](#struct-ipworksiotcoap) Struct) Sends a custom request to the server. ## Syntax *Rust Syntax* ```text fn send_custom_request(&self, uri : &str, method : i32) -> Result ``` ## Remarks This method sends the server a custom request for the resource identified by *URI*. The *Method* parameter specifies the request's method code. The following table provides a (non-exhaustive) list of some of the more common method codes; refer to the IANA's [CoAP Method Codes](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#method-codes) registry for a full list. | Method Code | Name | | --- | --- | | 1 | GET | | 2 | POST | | 3 | PUT | | 4 | DELETE | | 5 | FETCH | | 6 | PATCH | The [request_data](#request_data-property-coap-struct) property specifies the data that will be sent in the request. If the [request_content_format](#request_content_format-property-coap-struct) and/or [request_e_tag](#request_e_tag-property-coap-struct) properties are non-empty, their values will be used to include Content-Format and Etag options in the request (respectively). Any additional options present in the request_options properties will be included as well. The format of the *URI* parameter is *coap://hostname:port/resource*. The port is optional, and if not specified will default to 5683. For instance *coap://myserver/test* and *coap://myserver:5683/test* are equivalent. If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled when this method is called, the struct will automatically retransmit the request message (if necessary) until it receives confirmation from the server that it was received. Note that the retransmission period is not infinite; eventually the struct will assume that the message is undeliverable and time out the request. If the [timeout](#timeout-property-coap-struct) property is greater than *0*, this method will block until either a response is received, the specified timeout interval elapses, or (if [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string. If the [timeout](#timeout-property-coap-struct) property is *0*, a record of the request will be added to the pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the [cancel_request](#cancel_request-method-coap-struct) method will cancel the request (assuming it is still pending at that time). Once a response is received, or the request times out, the struct will do the following: - Populate the **Response*** properties (unless the request timed out). - Remove the request record from the pending_requests properties, if necessary. - Fire the [on_request_complete](#on_request_complete-event-coap-struct) event. Note: This method can only be called when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # send_notification method ([CoAP](#struct-ipworksiotcoap) Struct) Sends a notification to all clients observing a given resource. ## Syntax *Rust Syntax* ```text fn send_notification(&self, uri : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method sends a notification to all clients observing the resource identified by *URI*, notifying them of its latest state. Clients should be notified whenever a resource's content changes (or periodically, if it changes very often) by sending a 2.xx response code; typically *2.03* "Valid" or *2.05* "Content". Clients should *also* be notified if a resource can no longer be observed (e.g., when it is deleted) by sending a notification with a non-2.xx response code (e.g., *4.04* "Not Found"). The struct will automatically unregister all observers when a non-2.xx notification is sent. The [response_data](#response_data-property-coap-struct) property specifies the data that will be sent in the response, and the [response_code](#response_code-property-coap-struct) property specifies the response code. If the [response_content_format](#response_content_format-property-coap-struct) and/or [response_e_tag](#response_e_tag-property-coap-struct) properties are non-empty, their values will be used to include Content-Format and Etag options in the response (respectively). Any additional options present in the response_options properties will be included as well. If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled when this method is called, the struct will automatically retransmit the response message (if necessary) until it receives confirmation from the client that it was received. Note that the retransmission period is not infinite; eventually the struct will assume that the message is undeliverable and time out the response. Note: This method can only be called when the struct is operating in server mode (i.e., when the [listening](#listening-property-coap-struct) property is enabled). # send_response method ([CoAP](#struct-ipworksiotcoap) Struct) Sends a response for a given pending request to the corresponding client. ## Syntax *Rust Syntax* ```text fn send_response(&self, request_id : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method sends a response for the request in the pending_requests properties identified by *RequestId*. The [response_data](#response_data-property-coap-struct) property specifies the data that will be sent in the response, and the [response_code](#response_code-property-coap-struct) property specifies the response code. If the [response_content_format](#response_content_format-property-coap-struct) and/or [response_e_tag](#response_e_tag-property-coap-struct) properties are non-empty, their values will be used to include Content-Format and Etag options in the response (respectively). Any additional options present in the response_options properties will be included as well. If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled when this method is called, the struct will automatically retransmit the response message (if necessary) until it receives confirmation from the client that it was received. Note that the retransmission period is not infinite; eventually the struct will assume that the message is undeliverable and time out the response. The [on_response_complete](#on_response_complete-event-coap-struct) event will fire once the message receipt is confirmed (or once the retransmission period elapses). If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is disabled, the [on_response_complete](#on_response_complete-event-coap-struct) event will fire immediately instead, since there is no way to know whether the client received the response. Note: This method can only be called when the struct is operating in server mode (i.e., when the [listening](#listening-property-coap-struct) property is enabled). # start_listening method ([CoAP](#struct-ipworksiotcoap) Struct) This method starts listening for incoming connections. ## Syntax *Rust Syntax* ```text fn start_listening(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks This method begins listening for incoming connections on the port specified by [local_port](#local_port-property-coap-struct). Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [stop_listening](#stop_listening-method-coap-struct). To stop listening for new connections and to disconnect all existing clients, call shutdown. This method begins listening for incoming connections on the port specified by [local_port](#local_port-property-coap-struct). Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [stop_listening](#stop_listening-method-coap-struct). To stop listening for new connections and to disconnect all existing clients, call shutdown. # start_observing method ([CoAP](#struct-ipworksiotcoap) Struct) Registers the struct as an observer for a given resource. ## Syntax *Rust Syntax* ```text fn start_observing(&self, uri : &str) -> Result ``` ## Remarks This method registers the struct as an observer for the resource identified by *URI*. If the server accepts the registration, then it will periodically notify the struct about any changes to the specified resource. These "change notifications" are exposed via the [on_notification](#on_notification-event-coap-struct) event. This method operates in the exact same manner as the [get](#get-method-coap-struct) method, with the exception of the two things listed below. Refer to the [get](#get-method-coap-struct) method's documentation for more information. 1. When constructing the request, the struct automatically includes an Observe option. The presence of this option is what indicates to the server that the struct wishes to register itself as an observer for the specified resource. 2. When the server receives the request, its response causes the [on_notification](#on_notification-event-coap-struct) event to fire instead of the [on_request_complete](#on_request_complete-event-coap-struct) event. (Unless it decides to reject the registration, in which case it will handle the request just like a normal GET request, and the [on_request_complete](#on_request_complete-event-coap-struct) event will fire when its response is received, just like it would if [get](#get-method-coap-struct) had been called.) Once the struct has successfully registered itself as an observer, the server will continue to deliver change notifications for the specified resource until the struct unregisters, or the resource can no longer be observed (e.g., if it is deleted). To unregister, either call the [stop_observing](#stop_observing-method-coap-struct) method with the same *URI* value, or set the [on_notification](#on_notification-event-coap-struct) event's *StopObserving* parameter to *True*. Note: This method can only be called when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # stop_listening method ([CoAP](#struct-ipworksiotcoap) Struct) This method stops listening for new connections. ## Syntax *Rust Syntax* ```text fn stop_listening(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections. To stop listening and to disconnect all existing clients, call shutdown instead. This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections. To stop listening and to disconnect all existing clients, call shutdown instead. # stop_observing method ([CoAP](#struct-ipworksiotcoap) Struct) Unregisters the struct as an observer for a given resource. ## Syntax *Rust Syntax* ```text fn stop_observing(&self, uri : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method unregisters the struct as an observer for the resource identified by *URI*. This method operates in the exact same manner as the [get](#get-method-coap-struct) method, with the exception of the two things below; refer to the [get](#get-method-coap-struct) method's documentation for more information: 1. When constructing the request, the struct automatically includes an Observe option with a value of *1*. The presence of this option indicates to the server that the struct wishes to unregister from further change notifications. 2. This method, unlike [get](#get-method-coap-struct), does not return a request Id. Note: This method can only be called when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # on_error event ([CoAP](#struct-ipworksiotcoap) Struct) Fired when information is available about errors during data delivery. ## Syntax *Rust Syntax* ```text // CoAPErrorEventArgs carries the CoAP Error event's parameters. pub struct CoAPErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String } // CoAPErrorEvent defines the signature of the CoAP Error event's handler function. pub trait CoAPErrorEvent { fn on_error(&self, sender : CoAP, e : &mut CoAPErrorEventArgs); } impl <'a> CoAP<'a> { pub fn on_error(&self) -> &'a dyn CoAPErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn CoAPErrorEvent); ... } ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error. The *error_code* parameter contains an error code, and the *description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-coap-struct) section. # on_log event ([CoAP](#struct-ipworksiotcoap) Struct) Fires once for each log message. ## Syntax *Rust Syntax* ```text // CoAPLogEventArgs carries the CoAP Log event's parameters. pub struct CoAPLogEventArgs { fn log_level(&self) -> i32 fn message(&self) -> &String } // CoAPLogEvent defines the signature of the CoAP Log event's handler function. pub trait CoAPLogEvent { fn on_log(&self, sender : CoAP, e : &mut CoAPLogEventArgs); } impl <'a> CoAP<'a> { pub fn on_log(&self) -> &'a dyn CoAPLogEvent; pub fn set_on_log(&mut self, value : &'a dyn CoAPLogEvent); ... } ``` ## Remarks This event fires once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of the *Message*. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | # on_notification event ([CoAP](#struct-ipworksiotcoap) Struct) Fires when a notification is received from the server. ## Syntax *Rust Syntax* ```text // CoAPNotificationEventArgs carries the CoAP Notification event's parameters. pub struct CoAPNotificationEventArgs { fn uri(&self) -> &String fn is_latest(&self) -> bool fn stop_observing(&self) -> bool fn set_stop_observing(&self, value : bool) } // CoAPNotificationEvent defines the signature of the CoAP Notification event's handler function. pub trait CoAPNotificationEvent { fn on_notification(&self, sender : CoAP, e : &mut CoAPNotificationEventArgs); } impl <'a> CoAP<'a> { pub fn on_notification(&self) -> &'a dyn CoAPNotificationEvent; pub fn set_on_notification(&mut self, value : &'a dyn CoAPNotificationEvent); ... } ``` ## Remarks This event fires when the struct receives a notification from that server that some observed resource has changed. Query the [response_code](#response_code-property-coap-struct), [response_data](#response_data-property-coap-struct), [response_content_format](#response_content_format-property-coap-struct), [response_e_tag](#response_e_tag-property-coap-struct), and response_options properties to obtain the new resource information. Note that, in some cases, the server may no longer be able to deliver notifications for a resource (e.g., if it is deleted). In such cases, the [response_code](#response_code-property-coap-struct) property will be populated with a non-2.xx code (e.g., *4.04* "Not Found") to indicate why the resource can no longer be observed. No further notifications will be delivered for the resource after such a notification arrives. The *URI* parameter identifies the resource that has changed. The *IsLatest* parameter reflects whether this notification actually has the most recent resource information available, since it is possible for notifications to arrive out of order under certain circumstances. The *StopObserving* parameter specifies whether the struct should stop observing the resource identified by *URI*. This parameter is *False* by default, set it to *True* to have the struct unregister itself from further notifications. (Note: in the event of a non-2.xx notification, this parameter will be *True* by default instead, and changing it to *False* will have no effect.) Note: This event is only used when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # on_register event ([CoAP](#struct-ipworksiotcoap) Struct) Fires when a client wishes to register for notifications. ## Syntax *Rust Syntax* ```text // CoAPRegisterEventArgs carries the CoAP Register event's parameters. pub struct CoAPRegisterEventArgs { fn remote_host(&self) -> &String fn remote_port(&self) -> i32 fn uri(&self) -> &String fn uri_host(&self) -> &String fn uri_port(&self) -> i32 fn uri_path(&self) -> &String fn uri_query(&self) -> &String fn token(&self) -> &[u8] fn accept(&self) -> bool fn set_accept(&self, value : bool) } // CoAPRegisterEvent defines the signature of the CoAP Register event's handler function. pub trait CoAPRegisterEvent { fn on_register(&self, sender : CoAP, e : &mut CoAPRegisterEventArgs); } impl <'a> CoAP<'a> { pub fn on_register(&self) -> &'a dyn CoAPRegisterEvent; pub fn set_on_register(&mut self, value : &'a dyn CoAPRegisterEvent); ... } ``` ## Remarks This event fires anytime a client wishes to register itself as an observer for the resource identified by *URI*. Refer to the [start_observing](#start_observing-method-coap-struct) and [send_notification](#send_notification-method-coap-struct) methods, as well as the [on_notification](#on_notification-event-coap-struct) event, for more information about observing resources and resource change notifications. Any options included in the request can be obtained by querying the request_options properties. To correctly handle this event, populate the [response_code](#response_code-property-coap-struct), [response_data](#response_data-property-coap-struct), [response_content_format](#response_content_format-property-coap-struct), [response_e_tag](#response_e_tag-property-coap-struct), and response_options properties as desired before this event finishes. (This must be done regardless of the *Accept* parameter's final value; see below for more information on why). The *RemoteHost* parameter reflects the client's IP address or hostname. The *RemotePort* parameter reflects the client's port. The *URI* parameter reflects the exact resource URI that the client wishes to observe (the CoAP specification states that the full URI must be used to track observers). This value must be passed exactly as-is to the [send_notification](#send_notification-method-coap-struct) method to notify observers of changes to the resource. The *URIHost*, *URIPort*, *URIPath*, and *URIQuery* parameters are provided for additional convenience The *Token* parameter reflects the token included in the registration request. The *Accept* parameter specifies whether the struct should accept the registration. By default, it is *False*, and the request will be treated like a normal GET request. Setting it to *True* will cause the struct to add the client to its internal list of registered observers for the specified *URI*. Note: This event is only used when the struct is operating in server mode (i.e., when the [listening](#listening-property-coap-struct) property is enabled). # on_request event ([CoAP](#struct-ipworksiotcoap) Struct) Fires when a request is received from a client. ## Syntax *Rust Syntax* ```text // CoAPRequestEventArgs carries the CoAP Request event's parameters. pub struct CoAPRequestEventArgs { fn remote_host(&self) -> &String fn remote_port(&self) -> i32 fn method(&self) -> i32 fn uri_host(&self) -> &String fn uri_port(&self) -> i32 fn uri_path(&self) -> &String fn uri_query(&self) -> &String fn token(&self) -> &[u8] fn request_id(&self) -> &String fn send_response(&self) -> bool fn set_send_response(&self, value : bool) } // CoAPRequestEvent defines the signature of the CoAP Request event's handler function. pub trait CoAPRequestEvent { fn on_request(&self, sender : CoAP, e : &mut CoAPRequestEventArgs); } impl <'a> CoAP<'a> { pub fn on_request(&self) -> &'a dyn CoAPRequestEvent; pub fn set_on_request(&mut self, value : &'a dyn CoAPRequestEvent); ... } ``` ## Remarks This event fires anytime a request is received from a client. Information about the request is exposed both via this event's parameters and the following properties: [request_data](#request_data-property-coap-struct), [request_content_format](#request_content_format-property-coap-struct), [request_e_tag](#request_e_tag-property-coap-struct), and request_options. A response can either be sent back to the client immediately when the event finishes, or later using the [send_response](#send_response-method-coap-struct) method. Refer to the *RequestId* and *SendResponse* parameters' documentation, below, for more information. If a response is to be sent back immediately, populate the [response_code](#response_code-property-coap-struct), [response_data](#response_data-property-coap-struct), [response_content_format](#response_content_format-property-coap-struct), [response_e_tag](#response_e_tag-property-coap-struct), and response_options properties as desired before this event finishes. The *RemoteHost* parameter reflects the client's IP address or hostname. The *RemotePort* parameter reflects the client's port. The *Method* parameter reflects the request method code. The following table provides a (non-exhaustive) list of some of the more common method codes; refer to the IANA's [CoAP Method Codes](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#method-codes) registry for a full list. | Method Code | Name | | --- | --- | | 1 | GET | | 2 | POST | | 3 | PUT | | 4 | DELETE | | 5 | FETCH | | 6 | PATCH | The *URIHost*, *URIPort*, *URIPath*, and *URIQuery* parameters, when taken together, identify the resource that the client is making a request against. This event exposes the URI in pieces for convenience. The *Token* parameter reflects the token included in the request. The *RequestId* parameter reflects the struct-generated Id for the request. If the final value of the *SendResponse* parameter is *False*, this Id can be passed to the [send_response](#send_response-method-coap-struct) method later to send a response. (Alternatively, it can be passed to the [cancel_request](#cancel_request-method-coap-struct) later to ignore the request.) The *SendResponse* parameter specifies whether the struct should send a response back to the client immediately; it is *True* by default. Set it to *False* to send the response later instead. Note: This event is only used when the struct is operating in server mode (i.e., when the [listening](#listening-property-coap-struct) property is enabled). # on_request_complete event ([CoAP](#struct-ipworksiotcoap) Struct) Fires when a request completes. ## Syntax *Rust Syntax* ```text // CoAPRequestCompleteEventArgs carries the CoAP RequestComplete event's parameters. pub struct CoAPRequestCompleteEventArgs { fn method(&self) -> i32 fn uri(&self) -> &String fn request_id(&self) -> &String fn error_code(&self) -> i32 fn error_description(&self) -> &String } // CoAPRequestCompleteEvent defines the signature of the CoAP RequestComplete event's handler function. pub trait CoAPRequestCompleteEvent { fn on_request_complete(&self, sender : CoAP, e : &mut CoAPRequestCompleteEventArgs); } impl <'a> CoAP<'a> { pub fn on_request_complete(&self) -> &'a dyn CoAPRequestCompleteEvent; pub fn set_on_request_complete(&mut self, value : &'a dyn CoAPRequestCompleteEvent); ... } ``` ## Remarks This event fires when a request completes. Usually, a request is considered complete when a response has been received. However, requests can also be considered "complete" if either of the following occurs: - If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled, and the struct did not receive confirmation that the request was received before the retransmission period elapsed. - If [timeout](#timeout-property-coap-struct) property is greater than *0*, and the struct did not receive a response before the timeout period elapsed. Assuming a response *was* received (i.e., the *ErrorCode* parameter is either *0* or *709*; see below), then the response code, payload, and options can be obtained by querying the [response_code](#response_code-property-coap-struct), [response_data](#response_data-property-coap-struct), [response_content_format](#response_content_format-property-coap-struct), [response_e_tag](#response_e_tag-property-coap-struct), and response_options properties. The *Method* parameter reflects the request method code. The following table provides a (non-exhaustive) list of some of the more common method codes; refer to the IANA's [CoAP Method Codes](https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#method-codes) registry for a full list. | Method Code | Name | | --- | --- | | 1 | GET | | 2 | POST | | 3 | PUT | | 4 | DELETE | | 5 | FETCH | | 6 | PATCH | The *URI* parameter reflects the requested resource's URI. The *ErrorCode* parameter indicates whether the request encountered an error. If no error was encountered, it will be *0*; if the server returned a non-2.xx response code, it will be *709*; if some other error occurred (e.g., the request timed out), it will be another non-zero value. The *ErrorDescription* parameter provides a description of the error that occurred (or, if *ErrorCode* is *709*, a string version of the response code returned by the server). It will be empty if no error was encountered. Note: This event is only used when the struct is operating in client mode (i.e., when the [listening](#listening-property-coap-struct) property is disabled). # on_response_complete event ([CoAP](#struct-ipworksiotcoap) Struct) Fires when a response has been sent to a client. ## Syntax *Rust Syntax* ```text // CoAPResponseCompleteEventArgs carries the CoAP ResponseComplete event's parameters. pub struct CoAPResponseCompleteEventArgs { fn request_id(&self) -> &String fn error_code(&self) -> i32 fn error_description(&self) -> &String } // CoAPResponseCompleteEvent defines the signature of the CoAP ResponseComplete event's handler function. pub trait CoAPResponseCompleteEvent { fn on_response_complete(&self, sender : CoAP, e : &mut CoAPResponseCompleteEventArgs); } impl <'a> CoAP<'a> { pub fn on_response_complete(&self) -> &'a dyn CoAPResponseCompleteEvent; pub fn set_on_response_complete(&mut self, value : &'a dyn CoAPResponseCompleteEvent); ... } ``` ## Remarks This event fires anytime a response has been sent to a client. If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is enabled, then the response is considered complete once the client has confirmed that it received the response (or once the retransmission period elapses). If the [use_confirmable_messages](#use_confirmable_messages-property-coap-struct) property is disabled, the response is considered complete immediately (since there is no way to know if the client received it). The *RequestId* parameter reflects the struct-generated Id of the request for which the response was sent. The *ErrorCode* parameter indicates whether the response encountered an error (e.g., transmission timed out). If no error was encountered, it will be *0*. The *ErrorDescription* parameter provides a description of the error that occurred. It will be empty if no error was encountered. Note: This event is only used when the struct is operating in server mode (i.e., when the [listening](#listening-property-coap-struct) property is enabled). # on_ssl_client_authentication event ([CoAP](#struct-ipworksiotcoap) Struct) This event is fired when the client presents its credentials to the server. ## Syntax *Rust Syntax* ```text // CoAPSSLClientAuthenticationEventArgs carries the CoAP SSLClientAuthentication event's parameters. pub struct CoAPSSLClientAuthenticationEventArgs { fn connection_id(&self) -> i32 fn cert_encoded(&self) -> &[u8] fn cert_subject(&self) -> &String fn cert_issuer(&self) -> &String fn status(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // CoAPSSLClientAuthenticationEvent defines the signature of the CoAP SSLClientAuthentication event's handler function. pub trait CoAPSSLClientAuthenticationEvent { fn on_ssl_client_authentication(&self, sender : CoAP, e : &mut CoAPSSLClientAuthenticationEventArgs); } impl <'a> CoAP<'a> { pub fn on_ssl_client_authentication(&self) -> &'a dyn CoAPSSLClientAuthenticationEvent; pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn CoAPSSLClientAuthenticationEvent); ... } ``` ## Remarks This event enables the server to decide whether or not to continue. The *accept* parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *accept* is False, *status* shows why the verification failed (otherwise, *status* contains the string "OK"). # on_ssl_server_authentication event ([CoAP](#struct-ipworksiotcoap) Struct) Fired after the server presents its certificate to the client. ## Syntax *Rust Syntax* ```text // CoAPSSLServerAuthenticationEventArgs carries the CoAP SSLServerAuthentication event's parameters. pub struct CoAPSSLServerAuthenticationEventArgs { fn cert_encoded(&self) -> &[u8] fn cert_subject(&self) -> &String fn cert_issuer(&self) -> &String fn status(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // CoAPSSLServerAuthenticationEvent defines the signature of the CoAP SSLServerAuthentication event's handler function. pub trait CoAPSSLServerAuthenticationEvent { fn on_ssl_server_authentication(&self, sender : CoAP, e : &mut CoAPSSLServerAuthenticationEventArgs); } impl <'a> CoAP<'a> { pub fn on_ssl_server_authentication(&self) -> &'a dyn CoAPSSLServerAuthenticationEvent; pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn CoAPSSLServerAuthenticationEvent); ... } ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *accept* is False, *status* shows why the verification failed (otherwise, *status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *accept* parameter to True. # on_ssl_status event ([CoAP](#struct-ipworksiotcoap) Struct) Fired when secure connection progress messages are available. ## Syntax *Rust Syntax* ```text // CoAPSSLStatusEventArgs carries the CoAP SSLStatus event's parameters. pub struct CoAPSSLStatusEventArgs { fn message(&self) -> &String } // CoAPSSLStatusEvent defines the signature of the CoAP SSLStatus event's handler function. pub trait CoAPSSLStatusEvent { fn on_ssl_status(&self, sender : CoAP, e : &mut CoAPSSLStatusEventArgs); } impl <'a> CoAP<'a> { pub fn on_ssl_status(&self) -> &'a dyn CoAPSSLStatusEvent; pub fn set_on_ssl_status(&mut self, value : &'a dyn CoAPSSLStatusEvent); ... } ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # on_unregistered event ([CoAP](#struct-ipworksiotcoap) Struct) Fires when a client has unregistered from notifications. ## Syntax *Rust Syntax* ```text // CoAPUnregisteredEventArgs carries the CoAP Unregistered event's parameters. pub struct CoAPUnregisteredEventArgs { fn remote_host(&self) -> &String fn remote_port(&self) -> i32 fn uri(&self) -> &String fn uri_host(&self) -> &String fn uri_port(&self) -> i32 fn uri_path(&self) -> &String fn uri_query(&self) -> &String } // CoAPUnregisteredEvent defines the signature of the CoAP Unregistered event's handler function. pub trait CoAPUnregisteredEvent { fn on_unregistered(&self, sender : CoAP, e : &mut CoAPUnregisteredEventArgs); } impl <'a> CoAP<'a> { pub fn on_unregistered(&self) -> &'a dyn CoAPUnregisteredEvent; pub fn set_on_unregistered(&mut self, value : &'a dyn CoAPUnregisteredEvent); ... } ``` ## Remarks This event fires anytime a client has unregistered itself from further notifications for the resource identified by *URI*. Refer to the [start_observing](#start_observing-method-coap-struct) and [send_notification](#send_notification-method-coap-struct) methods, as well as the [on_notification](#on_notification-event-coap-struct) and [on_register](#on_register-event-coap-struct) events, for more information about observing resources and resource change notifications. The *RemoteHost* parameter reflects the client's IP address or hostname. The *RemotePort* parameter reflects the client's port. The *URI* parameter identifies the resource that the client has stopped observing. The *URIHost*, *URIPort*, *URIPath*, and *URIQuery* parameters are provided for additional convenience Note: This event is only used when the struct is operating in server mode (i.e., when the [listening](#listening-property-coap-struct) property is enabled). # Config Settings ([CoAP](#struct-ipworksiotcoap) Struct) The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-coap-struct) method. ### CoAP Config Settings **MessageId**: Sets the MessageId for a request.The struct will generate a MessageId automatically. This can be queried before sending a message or set to a value of your choice. **UseEmptyToken**: Uses an empty value for the request token.Set this to *true* to use an empty token value for requests. Set to *false* by default. **UseRawPublicKey**: Whether to enable Raw Public Key mode.When DTLS is enabled via [ssl_enabled](#ssl_enabled-property-coap-struct), the struct supports Certificate mode DTLS as defined by RFC 7252. Set this to *true* to use Raw Public Key mode instead. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When ssl_provider is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event-coap-struct) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if ssl_provider is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the struct will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the struct is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When ssl_provider is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error. When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error. When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [on_ssl_status](#on_ssl_status-event-coap-struct) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when [ssl_authenticate_clients](#ssl_authenticate_clients-property-coap-struct) is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when ssl_provider is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when ssl_provider is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when ssl_provider is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when ssl_provider is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the ssl_provider is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the struct when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when ssl_provider is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-coap-struct) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-coap-struct) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-coap-struct) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when ssl_provider is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when ssl_provider is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and ssl_provider is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### UDP Config Settings **CaptureIPPacketInfo**: Used to capture the packet information.If this is set to True, the component will capture the IP packet information. The default value for this setting is False. NOTE: This configuration setting is available only in Windows. **DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when remote_host is set. If *true* the struct will resolve the hostname and the IP address will be present in the remote_host property. If *false*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, resolve_remote_host may be called to manually resolve the value in remote_host at any time. The default value is *false*. **DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event. NOTE: This configuration setting is available only in Windows. **DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the struct will have the Don't Fragment flag set. The default value is False. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-coap-struct) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [local_host](#local_host-property-coap-struct) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [local_port](#local_port-property-coap-struct) after the connection is established. [local_port](#local_port-property-coap-struct) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the struct will accept without truncation. **QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).[UseConnection](#UseConnection) must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value. NOTE: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later. **QOSTrafficType**: Used to specify QOS/DSCP settings (optional).[UseConnection](#UseConnection) must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5). NOTE: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above. NOTE: QOSTrafficType must be set before setting active to True. **ShareLocalPort**: If set to True, allows more than one instance of the struct to be active on the same local port.This option must be set before the struct is activated through the active property or it will have no effect. The default value for this setting is False. **UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the struct should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the struct will send and receive data to and from the specified destination. The default value for this setting is False. **UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True. ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property-coap-struct) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([CoAP](#struct-ipworksiotcoap) Struct) ### CoAP Errors | | | | --- | --- | | 700 | Invalid or malformed URI. | | 701 | Invalid or malformed option. | | 702 | Invalid block. | | 703 | Malformed message. | | 704 | Message transmission timed out. | | 705 | Message rejected by remote host. | | 706 | Invalid/unexpected request Id. | | 707 | Invalid response code. | | 708 | "Reset" message received from remote host. | | 709 | Error response received from server. Refer to the error message for more information. | | 710 | Observation not supported for the requested URI. | | 711 | Request canceled. | | 712 | The requested operation cannot be performed in the current mode. |