CoAP Class
Properties Methods Events Config Settings Errors
An easy-to-use CoAP client and server implementation.
Class Name
IPWorksIoT_CoAP
Procedural Interface
ipworksiot_coap_open(); ipworksiot_coap_close($res); ipworksiot_coap_register_callback($res, $id, $function); ipworksiot_coap_get_last_error($res); ipworksiot_coap_get_last_error_code($res); ipworksiot_coap_set($res, $id, $index, $value); ipworksiot_coap_get($res, $id, $index); ipworksiot_coap_do_cancelrequest($res, $requestid); ipworksiot_coap_do_config($res, $configurationstring); ipworksiot_coap_do_delete($res, $uri); ipworksiot_coap_do_doevents($res); ipworksiot_coap_do_get($res, $uri); ipworksiot_coap_do_post($res, $uri); ipworksiot_coap_do_put($res, $uri); ipworksiot_coap_do_reset($res); ipworksiot_coap_do_sendcustomrequest($res, $uri, $method); ipworksiot_coap_do_sendnotification($res, $uri); ipworksiot_coap_do_sendresponse($res, $requestid); ipworksiot_coap_do_startlistening($res); ipworksiot_coap_do_startobserving($res, $uri); ipworksiot_coap_do_stoplistening($res); ipworksiot_coap_do_stopobserving($res, $uri);
Remarks
The CoAP class provides a lightweight, fully-featured CoAP client and server implementation with DTLS support.
Using the Class in Client Mode
While in client mode (i.e., the Listening property is disabled; its default setting), the class 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 SSLEnabled to True. UseRawPublicKey can be used to enable Raw Public Key mode.
When DTLS is enabled, relevant handshake details will be reported by the SSLStatus 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 SSLServerAuthentication event. If the Accept parameter of the SSLServerAuthentication 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 SSLCert property. This process may look like the following:
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 RequestData, RequestContentFormat, RequestETag, and RequestOptions properties (if necessary, and as applicable), then call one of the following methods:
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 ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions properties will be populated, and the RequestComplete event will fire. (If the request times out, the properties are not populated, but the event still fires.)
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 StartObserving 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 ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions properties to be populated, and the Notification event to fire.
To stop observing a resource, either call StopObserving with the same URI value used to call StartObserving, or set the Notification event's StopObserving parameter to True.
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 Class in Server Mode
To operate in server mode, set the LocalPort to the port the class should listen on (typically 5683, the standard CoAP port), then enable the Listening property. Each time a request arrives, the RequestData, RequestContentFormat, RequestETag, and RequestOptions properties will be populated, and the Request event will fire.
By default, the component operates in NoSec mode as defined by RFC 7252. Certificate mode DTLS can be enabled by setting SSLEnabled to True. 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 SSLCert property. Note the certificate must contain a private key.
After doing so, calling StartListening will cause the class to start listening for incoming connections. The class will listen on the interface defined by LocalHost and LocalPort, if specified. Otherwise, these values will be set by the class. If applicable, these values must be set before calling StartListening. For example:
//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 ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions properties as desired before the event finishes. Alternatively, the Request 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 SendResponse method later.
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 class can also support resource observation. When a client attempts to register itself as an observer of a resource, the Register event will fire; setting this event's Accept parameter to True will cause the class to accept the registration.
To notify clients that a resource has changed, populate the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions properties as desired, and then call the SendNotification method, passing it the URI of a resource that has registered observers.
When a client has unregistered from further change notifications, the Unregistered event will fire.
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 class 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());
}
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Listening | Whether the class should operate in server mode by listening for incoming requests. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds. |
PendingRequestCount | The number of records in the PendingRequest arrays. |
PendingRequestMethod | The request's method. |
PendingRequestRemoteHost | The remote host associated with the request. |
PendingRequestRemotePort | The remote port associated with the request. |
PendingRequestId | The request's Id. |
PendingRequestToken | The request's token. |
PendingRequestURI | The request URI. |
RequestContentFormat | The request content format. |
RequestData | The request data. |
RequestETag | The request ETag. |
RequestOptionCount | The number of records in the RequestOption arrays. |
RequestOptionCritical | Whether the option is critical. |
RequestOptionNoCacheKey | Whether the option is to be excluded from the cache-key. |
RequestOptionNumber | The option's number. |
RequestOptionUnsafe | Whether the option is unsafe to forward. |
RequestOptionValue | The option's value. |
RequestOptionValueType | The option's value data type. |
ResponseCode | The response code. |
ResponseContentFormat | The response content format. |
ResponseData | The response data. |
ResponseETag | The response ETag. |
ResponseOptionCount | The number of records in the ResponseOption arrays. |
ResponseOptionCritical | Whether the option is critical. |
ResponseOptionNoCacheKey | Whether the option is to be excluded from the cache-key. |
ResponseOptionNumber | The option's number. |
ResponseOptionUnsafe | Whether the option is unsafe to forward. |
ResponseOptionValue | The option's value. |
ResponseOptionValueType | The option's value data type. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLAuthenticateClients | If set to True, the server asks the client(s) for a certificate. |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Timeout | A timeout for the class. |
UseConfirmableMessages | Whether to use confirmable message. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
CancelRequest | Cancels a pending request. |
Config | Sets or retrieves a configuration setting. |
Delete | Sends a DELETE request to the server. |
DoEvents | This method processes events from the internal message queue. |
Get | Sends a GET request to the server. |
Post | Sends a POST request to the server. |
Put | Sends a PUT request to the server. |
Reset | This method will reset the class. |
SendCustomRequest | Sends a custom request to the server. |
SendNotification | Sends a notification to all clients observing a given resource. |
SendResponse | Sends a response for a given pending request to the corresponding client. |
StartListening | This method starts listening for incoming connections. |
StartObserving | Registers the class as an observer for a given resource. |
StopListening | This method stops listening for new connections. |
StopObserving | Unregisters the class as an observer for a given resource. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Error | Fired when information is available about errors during data delivery. |
Log | Fires once for each log message. |
Notification | Fires when a notification is received from the server. |
Register | Fires when a client wishes to register for notifications. |
Request | Fires when a request is received from a client. |
RequestComplete | Fires when a request completes. |
ResponseComplete | Fires when a response has been sent to a client. |
SSLClientAuthentication | This event is fired when the client presents its credentials to the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Unregistered | Fires when a client has unregistered from notifications. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
MessageId | Sets the MessageId for a request. |
UseEmptyToken | Uses an empty value for the request token. |
UseRawPublicKey | Whether to enable Raw Public Key mode. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
CaptureIPPacketInfo | Used to capture the packet information. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the class to be active on the same local port. |
SourceIPAddress | Used to set the source IP address used when sending a packet. |
SourceMacAddress | Used to set the source MAC address used when sending a packet. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Listening Property (IPWorksIoT_CoAP Class)
Whether the class should operate in server mode by listening for incoming requests.
Object Oriented Interface
public function getListening(); public function setListening($value);
Procedural Interface
ipworksiot_coap_get($res, 1 ); ipworksiot_coap_set($res, 1, $value );
Default Value
false
Remarks
This property indicates whether the class operates in server mode or client mode.
When this property is false (default), the class operate in client mode, allowing applications to send requests using the Get, Post, SendCustomRequest, etc. methods.
When this property is true, the class listens on LocalPort for incoming CoAP requests, firing the Request event anytime one arrives. Applications can service these requests directly during Request events, or send separate responses later using the SendResponse method.
Applications that wish to use the class in server mode should set the LocalPort property to the desired listening port (such as 5683, the standard CoAP port) before calling StartListening. Otherwise the system will choose a port at random.
Use the StartListening and StopListening methods to control whether the class is listening.
This property is not available at design time.
Data Type
Boolean
LocalHost Property (IPWorksIoT_CoAP Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworksiot_coap_get($res, 2 ); ipworksiot_coap_set($res, 2, $value );
Default Value
''
Remarks
The LocalHost 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 class initiate connections (or accept in the case of server classs) 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 class is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (IPWorksIoT_CoAP Class)
This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds.
Object Oriented Interface
public function getLocalPort(); public function setLocalPort($value);
Procedural Interface
ipworksiot_coap_get($res, 3 ); ipworksiot_coap_set($res, 3, $value );
Default Value
0
Remarks
The LocalPort property must be set before UDP is activated (Active is set to True). This instructs the class 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 LocalPort property after the connection is established.
LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.
The LocalPort property is useful when trying to connect to services that require a trusted port on the client side.
Data Type
Integer
PendingRequestCount Property (IPWorksIoT_CoAP Class)
The number of records in the PendingRequest arrays.
Object Oriented Interface
public function getPendingRequestCount();
Procedural Interface
ipworksiot_coap_get($res, 4 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- PendingRequestId
- PendingRequestMethod
- PendingRequestRemoteHost
- PendingRequestRemotePort
- PendingRequestToken
- PendingRequestURI
This property is read-only and not available at design time.
Data Type
Integer
PendingRequestMethod Property (IPWorksIoT_CoAP Class)
The request's method.
Object Oriented Interface
public function getPendingRequestMethod($pendingrequestindex);
Procedural Interface
ipworksiot_coap_get($res, 5 , $pendingrequestindex);
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 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 property.
This property is read-only and not available at design time.
Data Type
Integer
PendingRequestRemoteHost Property (IPWorksIoT_CoAP Class)
The remote host associated with the request.
Object Oriented Interface
public function getPendingRequestRemoteHost($pendingrequestindex);
Procedural Interface
ipworksiot_coap_get($res, 6 , $pendingrequestindex);
Default Value
''
Remarks
The remote host associated with the request.
This property reflects the remote host associated with the request. When the class 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 class 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 property.
This property is read-only and not available at design time.
Data Type
String
PendingRequestRemotePort Property (IPWorksIoT_CoAP Class)
The remote port associated with the request.
Object Oriented Interface
public function getPendingRequestRemotePort($pendingrequestindex);
Procedural Interface
ipworksiot_coap_get($res, 7 , $pendingrequestindex);
Default Value
0
Remarks
The remote port associated with the request.
This property reflects the remote port associated with the request. Refer to the PendingRequestRemoteHost 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 property.
This property is read-only and not available at design time.
Data Type
Integer
PendingRequestId Property (IPWorksIoT_CoAP Class)
The request's Id.
Object Oriented Interface
public function getPendingRequestId($pendingrequestindex);
Procedural Interface
ipworksiot_coap_get($res, 8 , $pendingrequestindex);
Default Value
''
Remarks
The request's Id.
This property reflects the request's class-generated Id.
The $pendingrequestindex parameter specifies the index of the item in the array. The size of the array is controlled by the PendingRequestCount property.
This property is read-only and not available at design time.
Data Type
String
PendingRequestToken Property (IPWorksIoT_CoAP Class)
The request's token.
Object Oriented Interface
public function getPendingRequestToken($pendingrequestindex);
Procedural Interface
ipworksiot_coap_get($res, 9 , $pendingrequestindex);
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 property.
This property is read-only and not available at design time.
Data Type
Binary String
PendingRequestURI Property (IPWorksIoT_CoAP Class)
The request URI.
Object Oriented Interface
public function getPendingRequestURI($pendingrequestindex);
Procedural Interface
ipworksiot_coap_get($res, 10 , $pendingrequestindex);
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 property.
This property is read-only and not available at design time.
Data Type
String
RequestContentFormat Property (IPWorksIoT_CoAP Class)
The request content format.
Object Oriented Interface
public function getRequestContentFormat(); public function setRequestContentFormat($value);
Procedural Interface
ipworksiot_coap_get($res, 11 ); ipworksiot_coap_set($res, 11, $value );
Default Value
-1
Remarks
When the class is operating in client mode (i.e., the Listening property is disabled), this property specifies the content format that should be included in outgoing requests.
When the class is operating in server mode (i.e., the Listening property is enabled), this property is populated with the content format included in incoming requests (if any) anytime the Request 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 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 |
This property is not available at design time.
Data Type
Integer
RequestData Property (IPWorksIoT_CoAP Class)
The request data.
Object Oriented Interface
public function getRequestData(); public function setRequestData($value);
Procedural Interface
ipworksiot_coap_get($res, 12 ); ipworksiot_coap_set($res, 12, $value );
Default Value
''
Remarks
When the class is operating in client mode (i.e., the Listening property is disabled), this property specifies the data that should be included in requests sent using Post, Put, or SendCustomRequest.
When the class is operating in server mode (i.e., the Listening property is enabled), this property is populated with the data included in incoming requests (if any) anytime the Request event fires.
This property is not available at design time.
Data Type
Binary String
RequestETag Property (IPWorksIoT_CoAP Class)
The request ETag.
Object Oriented Interface
public function getRequestETag(); public function setRequestETag($value);
Procedural Interface
ipworksiot_coap_get($res, 13 ); ipworksiot_coap_set($res, 13, $value );
Default Value
''
Remarks
When the class is operating in client mode (i.e., the Listening 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 class is operating in server mode (i.e., the Listening property is enabled), this property is populated with the ETag included in incoming requests (if any) anytime the Request event fires. It will be empty if an Etag option was not included.
This property is not available at design time.
Data Type
Binary String
RequestOptionCount Property (IPWorksIoT_CoAP Class)
The number of records in the RequestOption arrays.
Object Oriented Interface
public function getRequestOptionCount(); public function setRequestOptionCount($value);
Procedural Interface
ipworksiot_coap_get($res, 14 ); ipworksiot_coap_set($res, 14, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
- RequestOptionCritical
- RequestOptionNoCacheKey
- RequestOptionNumber
- RequestOptionUnsafe
- RequestOptionValue
- RequestOptionValueType
This property is not available at design time.
Data Type
Integer
RequestOptionCritical Property (IPWorksIoT_CoAP Class)
Whether the option is critical.
Object Oriented Interface
public function getRequestOptionCritical($requestoptionindex);
Procedural Interface
ipworksiot_coap_get($res, 15 , $requestoptionindex);
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 property.
This property is read-only and not available at design time.
Data Type
Boolean
RequestOptionNoCacheKey Property (IPWorksIoT_CoAP Class)
Whether the option is to be excluded from the cache-key.
Object Oriented Interface
public function getRequestOptionNoCacheKey($requestoptionindex);
Procedural Interface
ipworksiot_coap_get($res, 16 , $requestoptionindex);
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 property.
This property is read-only and not available at design time.
Data Type
Boolean
RequestOptionNumber Property (IPWorksIoT_CoAP Class)
The option's number.
Object Oriented Interface
public function getRequestOptionNumber($requestoptionindex); public function setRequestOptionNumber($requestoptionindex, $value);
Procedural Interface
ipworksiot_coap_get($res, 17 , $requestoptionindex); ipworksiot_coap_set($res, 17, $value , $requestoptionindex);
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 RequestOptionValueType 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 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 property.
This property is not available at design time.
Data Type
Integer
RequestOptionUnsafe Property (IPWorksIoT_CoAP Class)
Whether the option is unsafe to forward.
Object Oriented Interface
public function getRequestOptionUnsafe($requestoptionindex);
Procedural Interface
ipworksiot_coap_get($res, 18 , $requestoptionindex);
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 property.
This property is read-only and not available at design time.
Data Type
Boolean
RequestOptionValue Property (IPWorksIoT_CoAP Class)
The option's value.
Object Oriented Interface
public function getRequestOptionValue($requestoptionindex); public function setRequestOptionValue($requestoptionindex, $value);
Procedural Interface
ipworksiot_coap_get($res, 19 , $requestoptionindex); ipworksiot_coap_set($res, 19, $value , $requestoptionindex);
Default Value
''
Remarks
The option's value.
This property specifies the option's value. The RequestOptionValueType 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 property.
This property is not available at design time.
Data Type
String
RequestOptionValueType Property (IPWorksIoT_CoAP Class)
The option's value data type.
Object Oriented Interface
public function getRequestOptionValueType($requestoptionindex); public function setRequestOptionValueType($requestoptionindex, $value);
Procedural Interface
ipworksiot_coap_get($res, 20 , $requestoptionindex); ipworksiot_coap_set($res, 20, $value , $requestoptionindex);
Default Value
0
Remarks
The option's value data type.
This property specifies the data type of the option's RequestOptionValue. If RequestOptionNumber 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 RequestOptionValue.
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 property.
This property is not available at design time.
Data Type
Integer
ResponseCode Property (IPWorksIoT_CoAP Class)
The response code.
Object Oriented Interface
public function getResponseCode(); public function setResponseCode($value);
Procedural Interface
ipworksiot_coap_get($res, 21 ); ipworksiot_coap_set($res, 21, $value );
Default Value
''
Remarks
When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the response code included in incoming responses anytime the RequestComplete event fires.
When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the response code that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification).
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 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 |
This property is not available at design time.
Data Type
String
ResponseContentFormat Property (IPWorksIoT_CoAP Class)
The response content format.
Object Oriented Interface
public function getResponseContentFormat(); public function setResponseContentFormat($value);
Procedural Interface
ipworksiot_coap_get($res, 22 ); ipworksiot_coap_set($res, 22, $value );
Default Value
-1
Remarks
When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the content format included in incoming responses anytime the RequestComplete event fires.
When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the content format that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification).
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 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 |
This property is not available at design time.
Data Type
Integer
ResponseData Property (IPWorksIoT_CoAP Class)
The response data.
Object Oriented Interface
public function getResponseData(); public function setResponseData($value);
Procedural Interface
ipworksiot_coap_get($res, 23 ); ipworksiot_coap_set($res, 23, $value );
Default Value
''
Remarks
When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the data included in incoming responses (if any) anytime the RequestComplete event fires.
When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the data that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification).
This property is not available at design time.
Data Type
Binary String
ResponseETag Property (IPWorksIoT_CoAP Class)
The response ETag.
Object Oriented Interface
public function getResponseETag(); public function setResponseETag($value);
Procedural Interface
ipworksiot_coap_get($res, 24 ); ipworksiot_coap_set($res, 24, $value );
Default Value
''
Remarks
When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the ETag included in incoming responses (if any) anytime the RequestComplete event fires. It will be empty if an Etag option was not included.
When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the ETag that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification). Leave it empty to prevent an Etag option from being included.
This property is not available at design time.
Data Type
Binary String
ResponseOptionCount Property (IPWorksIoT_CoAP Class)
The number of records in the ResponseOption arrays.
Object Oriented Interface
public function getResponseOptionCount(); public function setResponseOptionCount($value);
Procedural Interface
ipworksiot_coap_get($res, 25 ); ipworksiot_coap_set($res, 25, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
- ResponseOptionCritical
- ResponseOptionNoCacheKey
- ResponseOptionNumber
- ResponseOptionUnsafe
- ResponseOptionValue
- ResponseOptionValueType
This property is not available at design time.
Data Type
Integer
ResponseOptionCritical Property (IPWorksIoT_CoAP Class)
Whether the option is critical.
Object Oriented Interface
public function getResponseOptionCritical($responseoptionindex);
Procedural Interface
ipworksiot_coap_get($res, 26 , $responseoptionindex);
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 property.
This property is read-only and not available at design time.
Data Type
Boolean
ResponseOptionNoCacheKey Property (IPWorksIoT_CoAP Class)
Whether the option is to be excluded from the cache-key.
Object Oriented Interface
public function getResponseOptionNoCacheKey($responseoptionindex);
Procedural Interface
ipworksiot_coap_get($res, 27 , $responseoptionindex);
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 property.
This property is read-only and not available at design time.
Data Type
Boolean
ResponseOptionNumber Property (IPWorksIoT_CoAP Class)
The option's number.
Object Oriented Interface
public function getResponseOptionNumber($responseoptionindex); public function setResponseOptionNumber($responseoptionindex, $value);
Procedural Interface
ipworksiot_coap_get($res, 28 , $responseoptionindex); ipworksiot_coap_set($res, 28, $value , $responseoptionindex);
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 ResponseOptionValueType 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 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 property.
This property is not available at design time.
Data Type
Integer
ResponseOptionUnsafe Property (IPWorksIoT_CoAP Class)
Whether the option is unsafe to forward.
Object Oriented Interface
public function getResponseOptionUnsafe($responseoptionindex);
Procedural Interface
ipworksiot_coap_get($res, 29 , $responseoptionindex);
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 property.
This property is read-only and not available at design time.
Data Type
Boolean
ResponseOptionValue Property (IPWorksIoT_CoAP Class)
The option's value.
Object Oriented Interface
public function getResponseOptionValue($responseoptionindex); public function setResponseOptionValue($responseoptionindex, $value);
Procedural Interface
ipworksiot_coap_get($res, 30 , $responseoptionindex); ipworksiot_coap_set($res, 30, $value , $responseoptionindex);
Default Value
''
Remarks
The option's value.
This property specifies the option's value. The ResponseOptionValueType 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 property.
This property is not available at design time.
Data Type
String
ResponseOptionValueType Property (IPWorksIoT_CoAP Class)
The option's value data type.
Object Oriented Interface
public function getResponseOptionValueType($responseoptionindex); public function setResponseOptionValueType($responseoptionindex, $value);
Procedural Interface
ipworksiot_coap_get($res, 31 , $responseoptionindex); ipworksiot_coap_set($res, 31, $value , $responseoptionindex);
Default Value
0
Remarks
The option's value data type.
This property specifies the data type of the option's ResponseOptionValue. If ResponseOptionNumber 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 ResponseOptionValue.
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 property.
This property is not available at design time.
Data Type
Integer
SSLAcceptServerCertEffectiveDate Property (IPWorksIoT_CoAP Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLAcceptServerCertEffectiveDate();
Procedural Interface
ipworksiot_coap_get($res, 32 );
Default Value
''
Remarks
This is 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
SSLAcceptServerCertExpirationDate Property (IPWorksIoT_CoAP Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLAcceptServerCertExpirationDate();
Procedural Interface
ipworksiot_coap_get($res, 33 );
Default Value
''
Remarks
This is the date 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
SSLAcceptServerCertExtendedKeyUsage Property (IPWorksIoT_CoAP Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLAcceptServerCertExtendedKeyUsage();
Procedural Interface
ipworksiot_coap_get($res, 34 );
Default Value
''
Remarks
This is 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
SSLAcceptServerCertFingerprint Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprint();
Procedural Interface
ipworksiot_coap_get($res, 35 );
Default Value
''
Remarks
This is 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
SSLAcceptServerCertFingerprintSHA1 Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA1();
Procedural Interface
ipworksiot_coap_get($res, 36 );
Default Value
''
Remarks
This is 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
SSLAcceptServerCertFingerprintSHA256 Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA256();
Procedural Interface
ipworksiot_coap_get($res, 37 );
Default Value
''
Remarks
This is 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
SSLAcceptServerCertIssuer Property (IPWorksIoT_CoAP Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertIssuer();
Procedural Interface
ipworksiot_coap_get($res, 38 );
Default Value
''
Remarks
This is 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
SSLAcceptServerCertPrivateKey Property (IPWorksIoT_CoAP Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKey();
Procedural Interface
ipworksiot_coap_get($res, 39 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksIoT_CoAP Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyAvailable();
Procedural Interface
ipworksiot_coap_get($res, 40 );
Default Value
false
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (IPWorksIoT_CoAP Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyContainer();
Procedural Interface
ipworksiot_coap_get($res, 41 );
Default Value
''
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (IPWorksIoT_CoAP Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKey();
Procedural Interface
ipworksiot_coap_get($res, 42 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksIoT_CoAP Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyAlgorithm();
Procedural Interface
ipworksiot_coap_get($res, 43 );
Default Value
''
Remarks
This property contains 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
SSLAcceptServerCertPublicKeyLength Property (IPWorksIoT_CoAP Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyLength();
Procedural Interface
ipworksiot_coap_get($res, 44 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (IPWorksIoT_CoAP Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLAcceptServerCertSerialNumber();
Procedural Interface
ipworksiot_coap_get($res, 45 );
Default Value
''
Remarks
This is 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
SSLAcceptServerCertSignatureAlgorithm Property (IPWorksIoT_CoAP Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertSignatureAlgorithm();
Procedural Interface
ipworksiot_coap_get($res, 46 );
Default Value
''
Remarks
The property contains 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
SSLAcceptServerCertStore Property (IPWorksIoT_CoAP Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStore(); public function setSSLAcceptServerCertStore($value);
Procedural Interface
ipworksiot_coap_get($res, 47 ); ipworksiot_coap_set($res, 47, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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
Binary String
SSLAcceptServerCertStorePassword Property (IPWorksIoT_CoAP Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLAcceptServerCertStorePassword(); public function setSSLAcceptServerCertStorePassword($value);
Procedural Interface
ipworksiot_coap_get($res, 48 ); ipworksiot_coap_set($res, 48, $value );
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
SSLAcceptServerCertStoreType Property (IPWorksIoT_CoAP Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStoreType(); public function setSSLAcceptServerCertStoreType($value);
Procedural Interface
ipworksiot_coap_get($res, 49 ); ipworksiot_coap_set($res, 49, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLAcceptServerCertSubjectAltNames Property (IPWorksIoT_CoAP Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertSubjectAltNames();
Procedural Interface
ipworksiot_coap_get($res, 50 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (IPWorksIoT_CoAP Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintMD5();
Procedural Interface
ipworksiot_coap_get($res, 51 );
Default Value
''
Remarks
This property contains 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
SSLAcceptServerCertThumbprintSHA1 Property (IPWorksIoT_CoAP Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA1();
Procedural Interface
ipworksiot_coap_get($res, 52 );
Default Value
''
Remarks
This property contains 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
SSLAcceptServerCertThumbprintSHA256 Property (IPWorksIoT_CoAP Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA256();
Procedural Interface
ipworksiot_coap_get($res, 53 );
Default Value
''
Remarks
This property contains 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
SSLAcceptServerCertUsage Property (IPWorksIoT_CoAP Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLAcceptServerCertUsage();
Procedural Interface
ipworksiot_coap_get($res, 54 );
Default Value
''
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
This value will be of 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
SSLAcceptServerCertUsageFlags Property (IPWorksIoT_CoAP Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertUsageFlags();
Procedural Interface
ipworksiot_coap_get($res, 55 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags 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 SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (IPWorksIoT_CoAP Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLAcceptServerCertVersion();
Procedural Interface
ipworksiot_coap_get($res, 56 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (IPWorksIoT_CoAP Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLAcceptServerCertSubject(); public function setSSLAcceptServerCertSubject($value);
Procedural Interface
ipworksiot_coap_get($res, 57 ); ipworksiot_coap_set($res, 57, $value );
Default Value
''
Remarks
This is 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=support@nsoftware.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
SSLAcceptServerCertEncoded Property (IPWorksIoT_CoAP Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
ipworksiot_coap_get($res, 58 ); ipworksiot_coap_set($res, 58, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLAuthenticateClients Property (IPWorksIoT_CoAP Class)
If set to True, the server asks the client(s) for a certificate.
Object Oriented Interface
public function getSSLAuthenticateClients(); public function setSSLAuthenticateClients($value);
Procedural Interface
ipworksiot_coap_get($res, 59 ); ipworksiot_coap_set($res, 59, $value );
Default Value
false
Remarks
This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.
Data Type
Boolean
SSLCertEffectiveDate Property (IPWorksIoT_CoAP Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLCertEffectiveDate();
Procedural Interface
ipworksiot_coap_get($res, 60 );
Default Value
''
Remarks
This is 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
SSLCertExpirationDate Property (IPWorksIoT_CoAP Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLCertExpirationDate();
Procedural Interface
ipworksiot_coap_get($res, 61 );
Default Value
''
Remarks
This is the date 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
SSLCertExtendedKeyUsage Property (IPWorksIoT_CoAP Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLCertExtendedKeyUsage();
Procedural Interface
ipworksiot_coap_get($res, 62 );
Default Value
''
Remarks
This is 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
SSLCertFingerprint Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprint();
Procedural Interface
ipworksiot_coap_get($res, 63 );
Default Value
''
Remarks
This is 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
SSLCertFingerprintSHA1 Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA1();
Procedural Interface
ipworksiot_coap_get($res, 64 );
Default Value
''
Remarks
This is 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
SSLCertFingerprintSHA256 Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA256();
Procedural Interface
ipworksiot_coap_get($res, 65 );
Default Value
''
Remarks
This is 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
SSLCertIssuer Property (IPWorksIoT_CoAP Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLCertIssuer();
Procedural Interface
ipworksiot_coap_get($res, 66 );
Default Value
''
Remarks
This is 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
SSLCertPrivateKey Property (IPWorksIoT_CoAP Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKey();
Procedural Interface
ipworksiot_coap_get($res, 67 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (IPWorksIoT_CoAP Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLCertPrivateKeyAvailable();
Procedural Interface
ipworksiot_coap_get($res, 68 );
Default Value
false
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (IPWorksIoT_CoAP Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKeyContainer();
Procedural Interface
ipworksiot_coap_get($res, 69 );
Default Value
''
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (IPWorksIoT_CoAP Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLCertPublicKey();
Procedural Interface
ipworksiot_coap_get($res, 70 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (IPWorksIoT_CoAP Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLCertPublicKeyAlgorithm();
Procedural Interface
ipworksiot_coap_get($res, 71 );
Default Value
''
Remarks
This property contains 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
SSLCertPublicKeyLength Property (IPWorksIoT_CoAP Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLCertPublicKeyLength();
Procedural Interface
ipworksiot_coap_get($res, 72 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (IPWorksIoT_CoAP Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLCertSerialNumber();
Procedural Interface
ipworksiot_coap_get($res, 73 );
Default Value
''
Remarks
This is 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
SSLCertSignatureAlgorithm Property (IPWorksIoT_CoAP Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLCertSignatureAlgorithm();
Procedural Interface
ipworksiot_coap_get($res, 74 );
Default Value
''
Remarks
The property contains 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
SSLCertStore Property (IPWorksIoT_CoAP Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
ipworksiot_coap_get($res, 75 ); ipworksiot_coap_set($res, 75, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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
Binary String
SSLCertStorePassword Property (IPWorksIoT_CoAP Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
ipworksiot_coap_get($res, 76 ); ipworksiot_coap_set($res, 76, $value );
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
SSLCertStoreType Property (IPWorksIoT_CoAP Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
ipworksiot_coap_get($res, 77 ); ipworksiot_coap_set($res, 77, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLCertSubjectAltNames Property (IPWorksIoT_CoAP Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLCertSubjectAltNames();
Procedural Interface
ipworksiot_coap_get($res, 78 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (IPWorksIoT_CoAP Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintMD5();
Procedural Interface
ipworksiot_coap_get($res, 79 );
Default Value
''
Remarks
This property contains 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
SSLCertThumbprintSHA1 Property (IPWorksIoT_CoAP Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA1();
Procedural Interface
ipworksiot_coap_get($res, 80 );
Default Value
''
Remarks
This property contains 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
SSLCertThumbprintSHA256 Property (IPWorksIoT_CoAP Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA256();
Procedural Interface
ipworksiot_coap_get($res, 81 );
Default Value
''
Remarks
This property contains 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
SSLCertUsage Property (IPWorksIoT_CoAP Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLCertUsage();
Procedural Interface
ipworksiot_coap_get($res, 82 );
Default Value
''
Remarks
This property contains the text description of SSLCertUsageFlags.
This value will be of 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
SSLCertUsageFlags Property (IPWorksIoT_CoAP Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLCertUsageFlags();
Procedural Interface
ipworksiot_coap_get($res, 83 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags 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 SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (IPWorksIoT_CoAP Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLCertVersion();
Procedural Interface
ipworksiot_coap_get($res, 84 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (IPWorksIoT_CoAP Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
ipworksiot_coap_get($res, 85 ); ipworksiot_coap_set($res, 85, $value );
Default Value
''
Remarks
This is 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=support@nsoftware.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
SSLCertEncoded Property (IPWorksIoT_CoAP Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
ipworksiot_coap_get($res, 86 ); ipworksiot_coap_set($res, 86, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLEnabled Property (IPWorksIoT_CoAP Class)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Object Oriented Interface
public function getSSLEnabled(); public function setSSLEnabled($value);
Procedural Interface
ipworksiot_coap_get($res, 87 ); ipworksiot_coap_set($res, 87, $value );
Default Value
false
Remarks
This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
Data Type
Boolean
SSLServerCertEffectiveDate Property (IPWorksIoT_CoAP Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLServerCertEffectiveDate();
Procedural Interface
ipworksiot_coap_get($res, 88 );
Default Value
''
Remarks
This is 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
SSLServerCertExpirationDate Property (IPWorksIoT_CoAP Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLServerCertExpirationDate();
Procedural Interface
ipworksiot_coap_get($res, 89 );
Default Value
''
Remarks
This is the date 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
SSLServerCertExtendedKeyUsage Property (IPWorksIoT_CoAP Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLServerCertExtendedKeyUsage();
Procedural Interface
ipworksiot_coap_get($res, 90 );
Default Value
''
Remarks
This is 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
SSLServerCertFingerprint Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprint();
Procedural Interface
ipworksiot_coap_get($res, 91 );
Default Value
''
Remarks
This is 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
SSLServerCertFingerprintSHA1 Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA1();
Procedural Interface
ipworksiot_coap_get($res, 92 );
Default Value
''
Remarks
This is 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
SSLServerCertFingerprintSHA256 Property (IPWorksIoT_CoAP Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA256();
Procedural Interface
ipworksiot_coap_get($res, 93 );
Default Value
''
Remarks
This is 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
SSLServerCertIssuer Property (IPWorksIoT_CoAP Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLServerCertIssuer();
Procedural Interface
ipworksiot_coap_get($res, 94 );
Default Value
''
Remarks
This is 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
SSLServerCertPrivateKey Property (IPWorksIoT_CoAP Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKey();
Procedural Interface
ipworksiot_coap_get($res, 95 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (IPWorksIoT_CoAP Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLServerCertPrivateKeyAvailable();
Procedural Interface
ipworksiot_coap_get($res, 96 );
Default Value
false
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (IPWorksIoT_CoAP Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKeyContainer();
Procedural Interface
ipworksiot_coap_get($res, 97 );
Default Value
''
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (IPWorksIoT_CoAP Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLServerCertPublicKey();
Procedural Interface
ipworksiot_coap_get($res, 98 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (IPWorksIoT_CoAP Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLServerCertPublicKeyAlgorithm();
Procedural Interface
ipworksiot_coap_get($res, 99 );
Default Value
''
Remarks
This property contains 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
SSLServerCertPublicKeyLength Property (IPWorksIoT_CoAP Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLServerCertPublicKeyLength();
Procedural Interface
ipworksiot_coap_get($res, 100 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (IPWorksIoT_CoAP Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLServerCertSerialNumber();
Procedural Interface
ipworksiot_coap_get($res, 101 );
Default Value
''
Remarks
This is 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
SSLServerCertSignatureAlgorithm Property (IPWorksIoT_CoAP Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLServerCertSignatureAlgorithm();
Procedural Interface
ipworksiot_coap_get($res, 102 );
Default Value
''
Remarks
The property contains 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
SSLServerCertStore Property (IPWorksIoT_CoAP Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLServerCertStore();
Procedural Interface
ipworksiot_coap_get($res, 103 );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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
Binary String
SSLServerCertStorePassword Property (IPWorksIoT_CoAP Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLServerCertStorePassword();
Procedural Interface
ipworksiot_coap_get($res, 104 );
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
SSLServerCertStoreType Property (IPWorksIoT_CoAP Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLServerCertStoreType();
Procedural Interface
ipworksiot_coap_get($res, 105 );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLServerCertSubjectAltNames Property (IPWorksIoT_CoAP Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLServerCertSubjectAltNames();
Procedural Interface
ipworksiot_coap_get($res, 106 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (IPWorksIoT_CoAP Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintMD5();
Procedural Interface
ipworksiot_coap_get($res, 107 );
Default Value
''
Remarks
This property contains 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
SSLServerCertThumbprintSHA1 Property (IPWorksIoT_CoAP Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA1();
Procedural Interface
ipworksiot_coap_get($res, 108 );
Default Value
''
Remarks
This property contains 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
SSLServerCertThumbprintSHA256 Property (IPWorksIoT_CoAP Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA256();
Procedural Interface
ipworksiot_coap_get($res, 109 );
Default Value
''
Remarks
This property contains 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
SSLServerCertUsage Property (IPWorksIoT_CoAP Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLServerCertUsage();
Procedural Interface
ipworksiot_coap_get($res, 110 );
Default Value
''
Remarks
This property contains the text description of SSLServerCertUsageFlags.
This value will be of 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
SSLServerCertUsageFlags Property (IPWorksIoT_CoAP Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLServerCertUsageFlags();
Procedural Interface
ipworksiot_coap_get($res, 111 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags 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 SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (IPWorksIoT_CoAP Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLServerCertVersion();
Procedural Interface
ipworksiot_coap_get($res, 112 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (IPWorksIoT_CoAP Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLServerCertSubject();
Procedural Interface
ipworksiot_coap_get($res, 113 );
Default Value
''
Remarks
This is 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=support@nsoftware.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
SSLServerCertEncoded Property (IPWorksIoT_CoAP Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
ipworksiot_coap_get($res, 114 );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (IPWorksIoT_CoAP Class)
A timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworksiot_coap_get($res, 115 ); ipworksiot_coap_set($res, 115, $value );
Default Value
60
Remarks
This property specifies the number of seconds that the class should wait, synchronously, for a response to be received. A value of 0 means that the class 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 class will use DoEvents 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 class throws an exception.
Data Type
Integer
UseConfirmableMessages Property (IPWorksIoT_CoAP Class)
Whether to use confirmable message.
Object Oriented Interface
public function getUseConfirmableMessages(); public function setUseConfirmableMessages($value);
Procedural Interface
ipworksiot_coap_get($res, 116 ); ipworksiot_coap_set($res, 116, $value );
Default Value
true
Remarks
This property specifies whether the class should send requests (if operating in client mode; i.e., when the Listening property is disabled) or responses (if operating in server mode; i.e., when the Listening property is enabled) using confirmable messages instead of unconfirmable messages.
Using confirmable messages increases reliability, since the class 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 class 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 class has no way to know whether a given message was received by the remote host, or lost in transit.
Data Type
Boolean
CancelRequest Method (IPWorksIoT_CoAP Class)
Cancels a pending request.
Object Oriented Interface
public function doCancelRequest($requestid);
Procedural Interface
ipworksiot_coap_do_cancelrequest($res, $requestid);
Remarks
This method cancels the request in the PendingRequests properties identified by RequestId.
When the class is operating in client mode, the requests in the PendingRequests properties represent outgoing requests for which responses have not yet been received. Canceling one will cause the RequestComplete event to fire with an appropriate ErrorCode and ErrorDescription.
When the class is operating in server mode, the requests in the PendingRequests properties represent incoming requests for which responses have not yet been sent. Canceling one will cause the ResponseComplete event to fire with an appropriate ErrorCode and ErrorDescription.
Config Method (IPWorksIoT_CoAP Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksiot_coap_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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, you must call Config("PROPERTY"). The value will be returned as a string.
Delete Method (IPWorksIoT_CoAP Class)
Sends a DELETE request to the server.
Object Oriented Interface
public function doDelete($uri);
Procedural Interface
ipworksiot_coap_do_delete($res, $uri);
Remarks
This method sends the server a DELETE request for the resource identified by URI. If the RequestETag property is non-empty, its value will be used to include an Etag option in the request. Any additional options present in the RequestOptions 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 UseConfirmableMessages property is enabled when this method is called, the class 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 class will assume that the message is undeliverable and time out the request.
If the Timeout property is greater than 0, this method will block until either a response is received, the specified timeout interval elapses, or (if UseConfirmableMessages is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string.
If the Timeout property is 0, a record of the request will be added to the PendingRequests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the CancelRequest method will cancel the request (assuming it is still pending at that time).
Once a response is received, or the request times out, the class will do the following:
- Populate the Response* properties (unless the request timed out).
- Remove the request record from the PendingRequests properties, if necessary.
- Fire the RequestComplete event.
Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).
DoEvents Method (IPWorksIoT_CoAP Class)
This method processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworksiot_coap_do_doevents($res);
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Get Method (IPWorksIoT_CoAP Class)
Sends a GET request to the server.
Object Oriented Interface
public function doGet($uri);
Procedural Interface
ipworksiot_coap_do_get($res, $uri);
Remarks
This method sends the server a GET request for the resource identified by URI. If the RequestETag property is non-empty, its value will be used to include an Etag option in the request. Any additional options present in the RequestOptions 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 UseConfirmableMessages property is enabled when this method is called, the class 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 class will assume that the message is undeliverable and time out the request.
If the Timeout property is greater than 0, this method will block until either a response is received, the specified timeout interval elapses, or (if UseConfirmableMessages is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string.
If the Timeout property is 0, a record of the request will be added to the PendingRequests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the CancelRequest method will cancel the request (assuming it is still pending at that time).
Once a response is received, or the request times out, the class will do the following:
- Populate the Response* properties (unless the request timed out).
- Remove the request record from the PendingRequests properties, if necessary.
- Fire the RequestComplete event.
Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).
Post Method (IPWorksIoT_CoAP Class)
Sends a POST request to the server.
Object Oriented Interface
public function doPost($uri);
Procedural Interface
ipworksiot_coap_do_post($res, $uri);
Remarks
This method sends the server a POST request for the resource identified by URI. The RequestData property specifies the data that will be sent in the request. If the RequestContentFormat and/or RequestETag 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 RequestOptions 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 UseConfirmableMessages property is enabled when this method is called, the class 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 class will assume that the message is undeliverable and time out the request.
If the Timeout property is greater than 0, this method will block until either a response is received, the specified timeout interval elapses, or (if UseConfirmableMessages is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string.
If the Timeout property is 0, a record of the request will be added to the PendingRequests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the CancelRequest method will cancel the request (assuming it is still pending at that time).
Once a response is received, or the request times out, the class will do the following:
- Populate the Response* properties (unless the request timed out).
- Remove the request record from the PendingRequests properties, if necessary.
- Fire the RequestComplete event.
Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).
Put Method (IPWorksIoT_CoAP Class)
Sends a PUT request to the server.
Object Oriented Interface
public function doPut($uri);
Procedural Interface
ipworksiot_coap_do_put($res, $uri);
Remarks
This method sends the server a PUT request for the resource identified by URI. The RequestData property specifies the data that will be sent in the request. If the RequestContentFormat and/or RequestETag 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 RequestOptions 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 UseConfirmableMessages property is enabled when this method is called, the class 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 class will assume that the message is undeliverable and time out the request.
If the Timeout property is greater than 0, this method will block until either a response is received, the specified timeout interval elapses, or (if UseConfirmableMessages is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string.
If the Timeout property is 0, a record of the request will be added to the PendingRequests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the CancelRequest method will cancel the request (assuming it is still pending at that time).
Once a response is received, or the request times out, the class will do the following:
- Populate the Response* properties (unless the request timed out).
- Remove the request record from the PendingRequests properties, if necessary.
- Fire the RequestComplete event.
Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).
Reset Method (IPWorksIoT_CoAP Class)
This method will reset the class.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksiot_coap_do_reset($res);
Remarks
This method will reset the class's properties to their default values.
SendCustomRequest Method (IPWorksIoT_CoAP Class)
Sends a custom request to the server.
Object Oriented Interface
public function doSendCustomRequest($uri, $method);
Procedural Interface
ipworksiot_coap_do_sendcustomrequest($res, $uri, $method);
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 registry for a full list.
Method Code | Name |
1 | GET |
2 | POST |
3 | PUT |
4 | DELETE |
5 | FETCH |
6 | PATCH |
The RequestData property specifies the data that will be sent in the request. If the RequestContentFormat and/or RequestETag 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 RequestOptions 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 UseConfirmableMessages property is enabled when this method is called, the class 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 class will assume that the message is undeliverable and time out the request.
If the Timeout property is greater than 0, this method will block until either a response is received, the specified timeout interval elapses, or (if UseConfirmableMessages is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string.
If the Timeout property is 0, a record of the request will be added to the PendingRequests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the CancelRequest method will cancel the request (assuming it is still pending at that time).
Once a response is received, or the request times out, the class will do the following:
- Populate the Response* properties (unless the request timed out).
- Remove the request record from the PendingRequests properties, if necessary.
- Fire the RequestComplete event.
Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).
SendNotification Method (IPWorksIoT_CoAP Class)
Sends a notification to all clients observing a given resource.
Object Oriented Interface
public function doSendNotification($uri);
Procedural Interface
ipworksiot_coap_do_sendnotification($res, $uri);
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 class will automatically unregister all observers when a non-2.xx notification is sent.
The ResponseData property specifies the data that will be sent in the response, and the ResponseCode property specifies the response code. If the ResponseContentFormat and/or ResponseETag 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 ResponseOptions properties will be included as well.
If the UseConfirmableMessages property is enabled when this method is called, the class 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 class will assume that the message is undeliverable and time out the response.
Note: This method can only be called when the class is operating in server mode (i.e., when the Listening property is enabled).
SendResponse Method (IPWorksIoT_CoAP Class)
Sends a response for a given pending request to the corresponding client.
Object Oriented Interface
public function doSendResponse($requestid);
Procedural Interface
ipworksiot_coap_do_sendresponse($res, $requestid);
Remarks
This method sends a response for the request in the PendingRequests properties identified by RequestId. The ResponseData property specifies the data that will be sent in the response, and the ResponseCode property specifies the response code. If the ResponseContentFormat and/or ResponseETag 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 ResponseOptions properties will be included as well.
If the UseConfirmableMessages property is enabled when this method is called, the class 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 class will assume that the message is undeliverable and time out the response. The ResponseComplete event will fire once the message receipt is confirmed (or once the retransmission period elapses).
If the UseConfirmableMessages property is disabled, the ResponseComplete 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 class is operating in server mode (i.e., when the Listening property is enabled).
StartListening Method (IPWorksIoT_CoAP Class)
This method starts listening for incoming connections.
Object Oriented Interface
public function doStartListening();
Procedural Interface
ipworksiot_coap_do_startlistening($res);
Remarks
This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.
To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.
StartObserving Method (IPWorksIoT_CoAP Class)
Registers the class as an observer for a given resource.
Object Oriented Interface
public function doStartObserving($uri);
Procedural Interface
ipworksiot_coap_do_startobserving($res, $uri);
Remarks
This method registers the class as an observer for the resource identified by URI. If the server accepts the registration, then it will periodically notify the class about any changes to the specified resource. These "change notifications" are exposed via the Notification event.
This method operates in the exact same manner as the Get method, with the exception of the two things listed below. Refer to the Get method's documentation for more information.
- When constructing the request, the class automatically includes an Observe option. The presence of this option is what indicates to the server that the class wishes to register itself as an observer for the specified resource.
- When the server receives the request, its response causes the Notification event to fire instead of the RequestComplete event. (Unless it decides to reject the registration, in which case it will handle the request just like a normal GET request, and the RequestComplete event will fire when its response is received, just like it would if Get had been called.)
Once the class has successfully registered itself as an observer, the server will continue to deliver change notifications for the specified resource until the class unregisters, or the resource can no longer be observed (e.g., if it is deleted). To unregister, either call the StopObserving method with the same URI value, or set the Notification event's StopObserving parameter to True.
Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).
StopListening Method (IPWorksIoT_CoAP Class)
This method stops listening for new connections.
Object Oriented Interface
public function doStopListening();
Procedural Interface
ipworksiot_coap_do_stoplistening($res);
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.
StopObserving Method (IPWorksIoT_CoAP Class)
Unregisters the class as an observer for a given resource.
Object Oriented Interface
public function doStopObserving($uri);
Procedural Interface
ipworksiot_coap_do_stopobserving($res, $uri);
Remarks
This method unregisters the class as an observer for the resource identified by URI. This method operates in the exact same manner as the Get method, with the exception of the two things below; refer to the Get method's documentation for more information:
- When constructing the request, the class automatically includes an Observe option with a value of 1. The presence of this option indicates to the server that the class wishes to unregister from further change notifications.
- This method, unlike Get, does not return a request Id.
Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).
Error Event (IPWorksIoT_CoAP Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 1, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode 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 section.
Log Event (IPWorksIoT_CoAP Class)
Fires once for each log message.
Object Oriented Interface
public function fireLog($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 2, array($this, 'fireLog'));
Parameter List
'loglevel'
'message'
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the 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. |
Notification Event (IPWorksIoT_CoAP Class)
Fires when a notification is received from the server.
Object Oriented Interface
public function fireNotification($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 3, array($this, 'fireNotification'));
Parameter List
'uri'
'islatest'
'stopobserving'
Remarks
This event fires when the class receives a notification from that server that some observed resource has changed. Query the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions 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 ResponseCode 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 class should stop observing the resource identified by URI. This parameter is False by default, set it to True to have the class 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 class is operating in client mode (i.e., when the Listening property is disabled).
Register Event (IPWorksIoT_CoAP Class)
Fires when a client wishes to register for notifications.
Object Oriented Interface
public function fireRegister($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 4, array($this, 'fireRegister'));
Parameter List
'remotehost'
'remoteport'
'uri'
'urihost'
'uriport'
'uripath'
'uriquery'
'token'
'accept'
Remarks
This event fires anytime a client wishes to register itself as an observer for the resource identified by URI. Refer to the StartObserving and SendNotification methods, as well as the Notification event, for more information about observing resources and resource change notifications.
Any options included in the request can be obtained by querying the RequestOptions properties.
To correctly handle this event, populate the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions 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 SendNotification 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 class 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 class to add the client to its internal list of registered observers for the specified URI.
Note: This event is only used when the class is operating in server mode (i.e., when the Listening property is enabled).
Request Event (IPWorksIoT_CoAP Class)
Fires when a request is received from a client.
Object Oriented Interface
public function fireRequest($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 5, array($this, 'fireRequest'));
Parameter List
'remotehost'
'remoteport'
'method'
'urihost'
'uriport'
'uripath'
'uriquery'
'token'
'requestid'
'sendresponse'
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: RequestData, RequestContentFormat, RequestETag, and RequestOptions.
A response can either be sent back to the client immediately when the event finishes, or later using the SendResponse method. Refer to the RequestId and SendResponse parameters' documentation, below, for more information. If a response is to be sent back immediately, populate the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions 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 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 class-generated Id for the request. If the final value of the SendResponse parameter is False, this Id can be passed to the SendResponse method later to send a response. (Alternatively, it can be passed to the CancelRequest later to ignore the request.)
The SendResponse parameter specifies whether the class 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 class is operating in server mode (i.e., when the Listening property is enabled).
RequestComplete Event (IPWorksIoT_CoAP Class)
Fires when a request completes.
Object Oriented Interface
public function fireRequestComplete($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 6, array($this, 'fireRequestComplete'));
Parameter List
'method'
'uri'
'requestid'
'errorcode'
'errordescription'
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 UseConfirmableMessages property is enabled, and the class did not receive confirmation that the request was received before the retransmission period elapsed.
- If Timeout property is greater than 0, and the class 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 ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions 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 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 class is operating in client mode (i.e., when the Listening property is disabled).
ResponseComplete Event (IPWorksIoT_CoAP Class)
Fires when a response has been sent to a client.
Object Oriented Interface
public function fireResponseComplete($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 7, array($this, 'fireResponseComplete'));
Parameter List
'requestid'
'errorcode'
'errordescription'
Remarks
This event fires anytime a response has been sent to a client. If the UseConfirmableMessages 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 UseConfirmableMessages 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 class-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 class is operating in server mode (i.e., when the Listening property is enabled).
SSLClientAuthentication Event (IPWorksIoT_CoAP Class)
This event is fired when the client presents its credentials to the server.
Object Oriented Interface
public function fireSSLClientAuthentication($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 8, array($this, 'fireSSLClientAuthentication'));
Parameter List
'connectionid'
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
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").
SSLServerAuthentication Event (IPWorksIoT_CoAP Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
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.
SSLStatus Event (IPWorksIoT_CoAP Class)
Fired when secure connection progress messages are available.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 10, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Unregistered Event (IPWorksIoT_CoAP Class)
Fires when a client has unregistered from notifications.
Object Oriented Interface
public function fireUnregistered($param);
Procedural Interface
ipworksiot_coap_register_callback($res, 11, array($this, 'fireUnregistered'));
Parameter List
'remotehost'
'remoteport'
'uri'
'urihost'
'uriport'
'uripath'
'uriquery'
Remarks
This event fires anytime a client has unregistered itself from further notifications for the resource identified by URI. Refer to the StartObserving and SendNotification methods, as well as the Notification and Register 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 class is operating in server mode (i.e., when the Listening property is enabled).
Config Settings (CoAP Class)
The class 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 class, access to these internal properties is provided through the Config method.CoAP Config Settings
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
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.
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.
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".
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.
If set to True, the class 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 class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----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-----
When set to 0 (default), the CRL check will not be performed by the class. 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.
When set to 0 (default), the class 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.
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 SSLStatus 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If 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 SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider 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
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 SSLProvider 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), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
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 class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider 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 and other similar SSL configuration settings are not supported.
- If 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 class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class 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 class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
When specified the class 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 class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider 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)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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)
UDP Config Settings
The default value for this setting is False.
Note: This configuration setting is available only in Windows.
The default value is false.
Note: This configuration setting is available only in Windows.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort 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.
Note: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.
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.
The default value for this setting is False.
Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
The default value for this setting is False.
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class 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
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 |
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 |
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class 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 section.
Trappable Errors (CoAP Class)
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. |