# GRPC Component The GRPC class is designed to send and receive messages over gRPC. The class can be used to both create messages to send as well as read incoming messages. ## Syntax ```text ipworks.GRPC ``` ## Remarks The GRPC struct is designed to send and receive messages over gRPC and operates using an HTTP/2 client. This component can be used to construct a message with fields as defined in the .proto configuration file. The created message can be sent through gRPC using the [Post](#post-method-grpc-component) method. If the request requires authorization, you can set the [Authorization](#authorization-property-grpc-component) property to the authorization header. Also, the component can be used to read an incoming message from the server. The GRPC struct supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the [SSLServerAuthentication](#sslserverauthentication-event-grpc-component) event allows you to check the server identity and other security attributes. The [SSLStatus](#sslstatus-event-grpc-component) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [Config](#config-method-grpc-component) method. ## Reading a Message The GRPC struct can be used to read an incoming message. To read an incoming message, listen to the [MessageIn](#messagein-event-grpc-component) event. The [MessageIn](#messagein-event-grpc-component) event will fire for each message response from the server. For each message response, the [MessageData](#messagedata-property-grpc-component) property will get populated with the raw message response from the server. The component can be used to read the response in a structured way. There are two ways of reading an incoming message. The message can be navigated using the [XPath](#xpath-property-grpc-component) property, or by sequentially reading the values in the message. By providing multiple ways to read a message, you can choose which best suits your needs. ### XPath [XPath](#xpath-property-grpc-component) provides a simple way to navigate the fields within the received message using a subset of the XML [XPath](#xpath-property-grpc-component) specification. The [XPath](#xpath-property-grpc-component) property may be set to navigate to a specific field within the message structure. The [HasXPath](#hasxpath-method-grpc-component) method may be used to determine whether or not an [XPath](#xpath-property-grpc-component) exists before setting navigating to the location. The [TryXPath](#tryxpath-method-grpc-component) method will attempt to navigate to the specified path and return True or False depending on the result. [XPath](#xpath-property-grpc-component) may be set to a series of one or more field accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current [XPath](#xpath-property-grpc-component) location. After setting the [XPath](#xpath-property-grpc-component) property, use any of the following methods to read data or information about the field at the selected path: - [ReadBool](#readbool-method-grpc-component) - [ReadBytes](#readbytes-method-grpc-component) - [ReadDouble](#readdouble-method-grpc-component) - [ReadFieldNumber](#readfieldnumber-method-grpc-component) - [ReadFixed32](#readfixed32-method-grpc-component) - [ReadFixed64](#readfixed64-method-grpc-component) - [ReadFloat](#readfloat-method-grpc-component) - [ReadInt32](#readint32-method-grpc-component) - [ReadInt64](#readint64-method-grpc-component) - [ReadString](#readstring-method-grpc-component) The following are possible values for a field accessor: | | | | --- | --- | | field_number | The integer number of the field: for instance, /2 or /11 | | field_number[i] | The i-th occurrence of the field specified by the field_number: for instance, /2[1] or /11[3] | | [index] | The field at the position specified by index: for instance, /[2] would select the second field, regardless of the field number | | . | The current location | | .. | The parent of the current location | **Nested Messages** When a field of a message is itself another message, the fields of the submessage may be accessed by constructing an XPath to point to the submessage field. For example, */5/4* would move to field number 5 in the top-level message (which is itself a message), and then would move to field number 4 of the submessage. **Packed Repeated Fields** The following example shows the syntax to access values within packed repeated fields. The type of value within the packed repeated field must be known ahead of time. The [XCount](#xcount-property-grpc-component) property can be used to obtain the number of values within the packed repeated field. | | | | --- | --- | | /10#v | Select field number 10, which is a packed repeated field of type variant | | /11#i | Select field number 11, which is a packed repeated field of type fixed32 | | /12#l | Select field number 12, which is a packed repeated field of type fixed64 | | /10#v[2] | Select the 2nd value of field number 10, which is a packed repeated field of type variant | | /11#v[2] | Select the 2nd value of field number 11, which is a packed repeated field of type fixed32 | | /12#v[2] | Select the 2nd value of field number 12, which is a packed repeated field of type fixed64 | Example. Iterate through all values within a packed repeated field: ```csharp gRPC.XPath = "/10#v"; int count = gRPC.XCount; for(int i=0;i { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-grpc-component), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-grpc-component), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-grpc-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-grpc-component) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-grpc-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SSLAcceptServerCertSubjectAltNames Property ([GRPC](#grpc-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintMD5 Property ([GRPC](#grpc-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintSHA1 Property ([GRPC](#grpc-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertThumbprintSHA256 Property ([GRPC](#grpc-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLAcceptServerCertUsage Property ([GRPC](#grpc-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-grpc-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLAcceptServerCertUsageFlags Property ([GRPC](#grpc-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-grpc-component) 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](#sslacceptservercertusage-property-grpc-component) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-grpc-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLAcceptServerCertVersion Property ([GRPC](#grpc-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLAcceptServerCertSubject Property ([GRPC](#grpc-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertSubject() (string, error)func (obj *GRPC) SetSSLAcceptServerCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SSLAcceptServerCertEncoded Property ([GRPC](#grpc-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLAcceptServerCertEncoded() ([]byte, error)func (obj *GRPC) SetSSLAcceptServerCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-grpc-component) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-grpc-component) properties also may be used to specify a certificate. When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-grpc-component) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-grpc-component) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-grpc-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-grpc-component) is set to an empty string. ## Data Type **[]byte** # SSLCertEffectiveDate Property ([GRPC](#grpc-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLCertExpirationDate Property ([GRPC](#grpc-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLCertExtendedKeyUsage Property ([GRPC](#grpc-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLCertFingerprint Property ([GRPC](#grpc-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLCertFingerprintSHA1 Property ([GRPC](#grpc-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLCertFingerprintSHA256 Property ([GRPC](#grpc-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLCertIssuer Property ([GRPC](#grpc-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLCertPrivateKey Property ([GRPC](#grpc-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-grpc-component) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-grpc-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLCertPrivateKeyAvailable Property ([GRPC](#grpc-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-grpc-component) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-grpc-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLCertPrivateKeyContainer Property ([GRPC](#grpc-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-grpc-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLCertPublicKey Property ([GRPC](#grpc-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLCertPublicKeyAlgorithm Property ([GRPC](#grpc-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLCertPublicKeyLength Property ([GRPC](#grpc-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLCertSerialNumber Property ([GRPC](#grpc-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLCertSignatureAlgorithm Property ([GRPC](#grpc-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLCertStore Property ([GRPC](#grpc-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertStore() ([]byte, error)func (obj *GRPC) SetSSLCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-grpc-component) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-grpc-component). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-grpc-component). [SSLCertStore](#sslcertstore-property-grpc-component) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-grpc-component) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-grpc-component) has a value, and [SSLCertSubject](#sslcertsubject-property-grpc-component) or [SSLCertEncoded](#sslcertencoded-property-grpc-component) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-grpc-component) 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 **[]byte** # SSLCertStorePassword Property ([GRPC](#grpc-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertStorePassword() (string, error)func (obj *GRPC) SetSSLCertStorePassword(value string) error ``` ## 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 ([GRPC](#grpc-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertStoreType() (int32, error)func (obj *GRPC) SetSSLCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-grpc-component), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-grpc-component), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-grpc-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-grpc-component) and set [SSLCertStorePassword](#sslcertstorepassword-property-grpc-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type **int32** # SSLCertSubjectAltNames Property ([GRPC](#grpc-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLCertThumbprintMD5 Property ([GRPC](#grpc-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertThumbprintSHA1 Property ([GRPC](#grpc-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertThumbprintSHA256 Property ([GRPC](#grpc-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLCertUsage Property ([GRPC](#grpc-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-grpc-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLCertUsageFlags Property ([GRPC](#grpc-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-grpc-component) 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](#sslcertusage-property-grpc-component) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-grpc-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLCertVersion Property ([GRPC](#grpc-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLCertSubject Property ([GRPC](#grpc-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertSubject() (string, error)func (obj *GRPC) SetSSLCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type **string** # SSLCertEncoded Property ([GRPC](#grpc-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLCertEncoded() ([]byte, error)func (obj *GRPC) SetSSLCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-grpc-component) and [SSLCertSubject](#sslcertsubject-property-grpc-component) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-grpc-component) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-grpc-component) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-grpc-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-grpc-component) is set to an empty string. ## Data Type **[]byte** # SSLProvider Property ([GRPC](#grpc-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLProvider() (int32, error)func (obj *GRPC) SetSSLProvider(value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Platform2 // Internal ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform. When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. ## Data Type **int32** # SSLServerCertEffectiveDate Property ([GRPC](#grpc-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertEffectiveDate() (string, error) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type **string** # SSLServerCertExpirationDate Property ([GRPC](#grpc-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertExpirationDate() (string, error) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type **string** # SSLServerCertExtendedKeyUsage Property ([GRPC](#grpc-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertExtendedKeyUsage() (string, error) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type **string** # SSLServerCertFingerprint Property ([GRPC](#grpc-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertFingerprint() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type **string** # SSLServerCertFingerprintSHA1 Property ([GRPC](#grpc-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertFingerprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type **string** # SSLServerCertFingerprintSHA256 Property ([GRPC](#grpc-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertFingerprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type **string** # SSLServerCertIssuer Property ([GRPC](#grpc-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertIssuer() (string, error) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKey Property ([GRPC](#grpc-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-grpc-component) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-grpc-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKeyAvailable Property ([GRPC](#grpc-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-grpc-component) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-grpc-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLServerCertPrivateKeyContainer Property ([GRPC](#grpc-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-grpc-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLServerCertPublicKey Property ([GRPC](#grpc-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertPublicKey() (string, error) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type **string** # SSLServerCertPublicKeyAlgorithm Property ([GRPC](#grpc-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertPublicKeyAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLServerCertPublicKeyLength Property ([GRPC](#grpc-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertPublicKeyLength() (int32, error) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type **int32** # SSLServerCertSerialNumber Property ([GRPC](#grpc-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertSerialNumber() (string, error) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type **string** # SSLServerCertSignatureAlgorithm Property ([GRPC](#grpc-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertSignatureAlgorithm() (string, error) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type **string** # SSLServerCertStore Property ([GRPC](#grpc-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertStore() ([]byte, error) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLServerCertStoreType](#sslservercertstoretype-property-grpc-component) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-grpc-component). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-grpc-component). [SSLServerCertStore](#sslservercertstore-property-grpc-component) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-grpc-component) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-grpc-component) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-grpc-component) or [SSLServerCertEncoded](#sslservercertencoded-property-grpc-component) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-grpc-component) 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 **[]byte** # SSLServerCertStorePassword Property ([GRPC](#grpc-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertStorePassword() (string, error) ``` ## 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 ([GRPC](#grpc-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertStoreType() (int32, error) ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-grpc-component), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-grpc-component), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-grpc-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-grpc-component) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-grpc-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | This property is read-only. ## Data Type **int32** # SSLServerCertSubjectAltNames Property ([GRPC](#grpc-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintMD5 Property ([GRPC](#grpc-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertThumbprintMD5() (string, error) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintSHA1 Property ([GRPC](#grpc-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertThumbprintSHA1() (string, error) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertThumbprintSHA256 Property ([GRPC](#grpc-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertThumbprintSHA256() (string, error) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type **string** # SSLServerCertUsage Property ([GRPC](#grpc-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-grpc-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type **string** # SSLServerCertUsageFlags Property ([GRPC](#grpc-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-grpc-component) 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](#sslservercertusage-property-grpc-component) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-grpc-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLServerCertVersion Property ([GRPC](#grpc-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertVersion() (string, error) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type **string** # SSLServerCertSubject Property ([GRPC](#grpc-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertSubject() (string, error) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. This property is read-only. ## Data Type **string** # SSLServerCertEncoded Property ([GRPC](#grpc-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *GRPC) SSLServerCertEncoded() ([]byte, error) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-grpc-component) and [SSLServerCertSubject](#sslservercertsubject-property-grpc-component) properties also may be used to specify a certificate. When [SSLServerCertEncoded](#sslservercertencoded-property-grpc-component) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-grpc-component) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-grpc-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-grpc-component) is set to an empty string. This property is read-only. ## Data Type **[]byte** # Status Property ([GRPC](#grpc-component) Component) This property includes the gRPC status code. ## Syntax *Go Syntax* ```text func (obj *GRPC) Status() (string, error) ``` ## Default Value "" ## Remarks This property contains the gRPC status code returned by the server when the request is sent through [Post](#post-method-grpc-component). This property is read-only. ## Data Type **string** # StatusDescription Property ([GRPC](#grpc-component) Component) This property includes a unicode string description of an error, which is physically encoded as UTF-8 followed by percent-encoding. ## Syntax *Go Syntax* ```text func (obj *GRPC) StatusDescription() (string, error) ``` ## Default Value "" ## Remarks This property contains a unicode string description of any existing error, which is physically encoded as UTF-8 followed by percent-encoding. If there are no errors, the value of the property will be an empty string. This property is read-only. ## Data Type **string** # StatusLine Property ([GRPC](#grpc-component) Component) This property is the first line of the last server response. ## Syntax *Go Syntax* ```text func (obj *GRPC) StatusLine() (string, error) ``` ## Default Value "" ## Remarks This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the struct, the error string is the same as the StatusLine property. The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description]. This property is read-only. ## Data Type **string** # Timeout Property ([GRPC](#grpc-component) Component) The timeout for the class. ## Syntax *Go Syntax* ```text func (obj *GRPC) Timeout() (int32, error)func (obj *GRPC) SetTimeout(value int32) error ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the struct will wait for the operation to complete before returning control. The struct will use [DoEvents](#doevents-method-grpc-component) to enter an efficient wait loop during any potential waiting period, making sure 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 operation is not yet complete, the struct fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. ## Data Type **int32** # TransferredData Property ([GRPC](#grpc-component) Component) This property includes the contents of the last response from the server. ## Syntax *Go Syntax* ```text func (obj *GRPC) TransferredData() ([]byte, error) ``` ## Default Value "" ## Remarks This property contains the contents of the last response from the server. The data also can be received in the [Transfer](#transfer-event-grpc-component) event. [TransferredDataLimit](#transferreddatalimit-property-grpc-component) controls the maximum amount of data accumulated in TransferredData (by default, there is no limit). This property is read-only. ## Data Type **[]byte** # TransferredDataLimit Property ([GRPC](#grpc-component) Component) This property specifies the maximum amount of data to be transferred. ## Syntax *Go Syntax* ```text func (obj *GRPC) TransferredDataLimit() (int64, error)func (obj *GRPC) SetTransferredDataLimit(value int64) error ``` ## Default Value 0 ## Remarks This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the [TransferredData](#transferreddata-property-grpc-component) property. ## Data Type **int64** # TransferredHeaders Property ([GRPC](#grpc-component) Component) This property includes the complete set of headers as received from the server. ## Syntax *Go Syntax* ```text func (obj *GRPC) TransferredHeaders() (string, error) ``` ## Default Value "" ## Remarks This property returns the complete set of raw headers as received from the server. This property is read-only. ## Data Type **string** # URL Property ([GRPC](#grpc-component) Component) This property includes the URL to post. ## Syntax *Go Syntax* ```text func (obj *GRPC) URL() (string, error)func (obj *GRPC) SetURL(value string) error ``` ## Default Value "" ## Remarks This property contains the URL of the document that is used during the [Post](#post-method-grpc-component) operation. ## Data Type **string** # XCount Property ([GRPC](#grpc-component) Component) This property includes the number of packed fields or instances of the field specified by XPath . ## Syntax *Go Syntax* ```text func (obj *GRPC) XCount() (int32, error) ``` ## Default Value 0 ## Remarks The XCount property can be used to obtain the number of values in a packed repeated field at the specified [XPath](#xpath-property-grpc-component). When [XPath](#xpath-property-grpc-component) specifies a field that is not a packed repeated field, XCount will return the number of instances of the specified field. Even if the field is not a repeated field, it may still have multiple instances within the message, and XCount will reflect this number of instances. **Example. Using XCount and [XPath](#xpath-property-grpc-component) to iterate through all values within a packed repeated field:** ```csharp gRPC.XPath = "/10#v"; int count = gRPC.XCount; for(int i=0;i 0) { switch (num) { case 1: Name = grpc.ReadString(); break; case 2: // ReadSkip is used to skip reading value with field number 2 grpc.ReadSkip(); break; case 3: Num64 = grpc.ReadInt64(); break; } // Ends reading a message grpc.EndReadMessage(); ``` # ReadString Method ([GRPC](#grpc-component) Component) This method reads the string value from the current field number and returns it. ## Syntax *Go Syntax* ```text func (obj *GRPC) ReadString() (string, error) ``` ## Remarks This method reads the string value from the current field number and returns it. The current field number is specified by the component when calling [ReadFieldNumber](#readfieldnumber-method-grpc-component). The [ReadFieldNumber](#readfieldnumber-method-grpc-component) method must be called before calling ReadString. # Reset Method ([GRPC](#grpc-component) Component) This method will reset the class. ## Syntax *Go Syntax* ```text func (obj *GRPC) Reset() error ``` ## Remarks This method will reset the struct's properties to their default values. # TryXPath Method ([GRPC](#grpc-component) Component) This method navigates to the specified XPath if it exists. ## Syntax *Go Syntax* ```text func (obj *GRPC) TryXPath(xpath string) (bool, error) ``` ## Remarks This method will attempt to navigate to the specified XPath parameter if it exists within the document. If the XPath exists, the [XPath](#xpath-property-grpc-component) property will be updated, and the method will return True. If the XPath does not exist, the [XPath](#xpath-property-grpc-component) property will not be updated, and the method will return False. # WriteBool Method ([GRPC](#grpc-component) Component) This method writes a Boolean value to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteBool(value bool) error ``` ## Remarks This method is used to write a Boolean value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The Boolean value must be passed to the *value* parameter. # WriteBytes Method ([GRPC](#grpc-component) Component) This method writes a value of type byte to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteBytes(value []byte) error ``` ## Remarks This method is used to write a value of type byte to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The value of type byte must be passed to the *value* parameter. # WriteDouble Method ([GRPC](#grpc-component) Component) This method writes a value of type double to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteDouble(value string) error ``` ## Remarks This method is used to write a value of type double to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The value of type double must be passed to the *value* parameter. # WriteFieldNumber Method ([GRPC](#grpc-component) Component) This method specifies the field number to write. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteFieldNumber(value int32) error ``` ## Remarks This method tells the component which message field number to write. The field number must be passed to the *value* parameter. This method must be called before writing the field value. # WriteFixed32 Method ([GRPC](#grpc-component) Component) This method writes a fixed32 value to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteFixed32(value int32) error ``` ## Remarks This method is used to write a fixed32 value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The fixed32 value must be passed to the *value* parameter. # WriteFixed64 Method ([GRPC](#grpc-component) Component) This method writes a fixed64 value to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteFixed64(value int64) error ``` ## Remarks This method is used to write a fixed64 value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The fixed64 value must be passed to the *value* parameter. # WriteFloat Method ([GRPC](#grpc-component) Component) This method writes a float value to the current field number specified. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteFloat(value string) error ``` ## Remarks This method is used to write a float value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The float value must be passed to the *value* parameter. # WriteInt32 Method ([GRPC](#grpc-component) Component) This method writes an int32 value to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteInt32(value int32) error ``` ## Remarks This method is used to write an int32 value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The int32 value must be passed to the *value* parameter. # WriteInt64 Method ([GRPC](#grpc-component) Component) This method writes an int64 value to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteInt64(value int64) error ``` ## Remarks This method is used to write an int64 value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The int64 value must be passed to the *value* parameter. # WriteSint32 Method ([GRPC](#grpc-component) Component) This method writes an sint32 value to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteSint32(value int32) error ``` ## Remarks This method is used to write an sint32 value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The sint32 value must be passed to the *value* parameter. # WriteSint64 Method ([GRPC](#grpc-component) Component) This method writes an sint64 value to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteSint64(value int64) error ``` ## Remarks This method is used to write an sint64 value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The sint364 value must be passed to the *value* parameter. # WriteString Method ([GRPC](#grpc-component) Component) This method writes a string value to the current field number. ## Syntax *Go Syntax* ```text func (obj *GRPC) WriteString(value string) error ``` ## Remarks This method is used to write a string value to the current field number. The current field number must be specified with the [WriteFieldNumber](#writefieldnumber-method-grpc-component) method before calling this method. The string value must be passed to the *value* parameter. # Connected Event ([GRPC](#grpc-component) Component) Fired immediately after a connection completes (or fails). ## Syntax *Go Syntax* ```text // GRPCConnectedEventArgs carries the GRPC Connected event's parameters. type GRPCConnectedEventArgs struct {...} func (args *GRPCConnectedEventArgs) StatusCode() int32 func (args *GRPCConnectedEventArgs) Description() string // GRPCConnectedEvent defines the signature of the GRPC Connected event's handler function. type GRPCConnectedEvent func(sender *GRPC, args *GRPCConnectedEventArgs) func (obj *GRPC) GetOnConnectedHandler() GRPCConnectedEvent func (obj *GRPC) SetOnConnectedHandler(handlerFunc GRPCConnectedEvent) ``` ## Remarks If the connection is made normally, *StatusCode* is 0 and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. Please refer to the [Error Codes](#trappable-errors-grpc-component) section for more information. # ConnectionStatus Event ([GRPC](#grpc-component) Component) Fired to indicate changes in the connection state. ## Syntax *Go Syntax* ```text // GRPCConnectionStatusEventArgs carries the GRPC ConnectionStatus event's parameters. type GRPCConnectionStatusEventArgs struct {...} func (args *GRPCConnectionStatusEventArgs) ConnectionEvent() string func (args *GRPCConnectionStatusEventArgs) StatusCode() int32 func (args *GRPCConnectionStatusEventArgs) Description() string // GRPCConnectionStatusEvent defines the signature of the GRPC ConnectionStatus event's handler function. type GRPCConnectionStatusEvent func(sender *GRPC, args *GRPCConnectionStatusEventArgs) func (obj *GRPC) GetOnConnectionStatusHandler() GRPCConnectionStatusEvent func (obj *GRPC) SetOnConnectionStatusHandler(handlerFunc GRPCConnectionStatusEvent) ``` ## Remarks This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake. The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. # Disconnected Event ([GRPC](#grpc-component) Component) Fired when a connection is closed. ## Syntax *Go Syntax* ```text // GRPCDisconnectedEventArgs carries the GRPC Disconnected event's parameters. type GRPCDisconnectedEventArgs struct {...} func (args *GRPCDisconnectedEventArgs) StatusCode() int32 func (args *GRPCDisconnectedEventArgs) Description() string // GRPCDisconnectedEvent defines the signature of the GRPC Disconnected event's handler function. type GRPCDisconnectedEvent func(sender *GRPC, args *GRPCDisconnectedEventArgs) func (obj *GRPC) GetOnDisconnectedHandler() GRPCDisconnectedEvent func (obj *GRPC) SetOnDisconnectedHandler(handlerFunc GRPCDisconnectedEvent) ``` ## Remarks If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK". If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error. Please refer to the [Error Codes](#trappable-errors-grpc-component) section for more information. # EndTransfer Event ([GRPC](#grpc-component) Component) Fired when a document finishes transferring. ## Syntax *Go Syntax* ```text // GRPCEndTransferEventArgs carries the GRPC EndTransfer event's parameters. type GRPCEndTransferEventArgs struct {...} func (args *GRPCEndTransferEventArgs) Direction() int32 // GRPCEndTransferEvent defines the signature of the GRPC EndTransfer event's handler function. type GRPCEndTransferEvent func(sender *GRPC, args *GRPCEndTransferEventArgs) func (obj *GRPC) GetOnEndTransferHandler() GRPCEndTransferEvent func (obj *GRPC) SetOnEndTransferHandler(handlerFunc GRPCEndTransferEvent) ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Error Event ([GRPC](#grpc-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Go Syntax* ```text // GRPCErrorEventArgs carries the GRPC Error event's parameters. type GRPCErrorEventArgs struct {...} func (args *GRPCErrorEventArgs) ErrorCode() int32 func (args *GRPCErrorEventArgs) Description() string // GRPCErrorEvent defines the signature of the GRPC Error event's handler function. type GRPCErrorEvent func(sender *GRPC, args *GRPCErrorEventArgs) func (obj *GRPC) GetOnErrorHandler() GRPCErrorEvent func (obj *GRPC) SetOnErrorHandler(handlerFunc GRPCErrorEvent) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the struct 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](#trappable-errors-grpc-component) section. # Log Event ([GRPC](#grpc-component) Component) Fired once for each log message. ## Syntax *Go Syntax* ```text // GRPCLogEventArgs carries the GRPC Log event's parameters. type GRPCLogEventArgs struct {...} func (args *GRPCLogEventArgs) LogLevel() int32 func (args *GRPCLogEventArgs) Message() string func (args *GRPCLogEventArgs) LogType() string // GRPCLogEvent defines the signature of the GRPC Log event's handler function. type GRPCLogEvent func(sender *GRPC, args *GRPCLogEventArgs) func (obj *GRPC) GetOnLogHandler() GRPCLogEvent func (obj *GRPC) SetOnLogHandler(handlerFunc GRPCLogEvent) ``` ## Remarks This event is fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # MessageIn Event ([GRPC](#grpc-component) Component) This event fires when a message response is sent by the server. ## Syntax *Go Syntax* ```text // GRPCMessageInEventArgs carries the GRPC MessageIn event's parameters. type GRPCMessageInEventArgs struct {...} func (args *GRPCMessageInEventArgs) Compressed() bool func (args *GRPCMessageInEventArgs) MessageLength() int32 // GRPCMessageInEvent defines the signature of the GRPC MessageIn event's handler function. type GRPCMessageInEvent func(sender *GRPC, args *GRPCMessageInEventArgs) func (obj *GRPC) GetOnMessageInHandler() GRPCMessageInEvent func (obj *GRPC) SetOnMessageInHandler(handlerFunc GRPCMessageInEvent) ``` ## Remarks This event fires for every message response sent by the server after calling [Post](#post-method-grpc-component). Every time this event fires, the [MessageData](#messagedata-property-grpc-component) property is populated with the raw data of the response. *Compressed* is a Boolean indicating whether or not the message is in a compressed state. The length of the message is shown by *MessageLength*. # Redirect Event ([GRPC](#grpc-component) Component) Fired when a redirection is received from the server. ## Syntax *Go Syntax* ```text // GRPCRedirectEventArgs carries the GRPC Redirect event's parameters. type GRPCRedirectEventArgs struct {...} func (args *GRPCRedirectEventArgs) Location() string func (args *GRPCRedirectEventArgs) Accept() bool func (args *GRPCRedirectEventArgs) SetAccept(value bool) // GRPCRedirectEvent defines the signature of the GRPC Redirect event's handler function. type GRPCRedirectEvent func(sender *GRPC, args *GRPCRedirectEventArgs) func (obj *GRPC) GetOnRedirectHandler() GRPCRedirectEvent func (obj *GRPC) SetOnRedirectHandler(handlerFunc GRPCRedirectEvent) ``` ## Remarks This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The *Accept* parameter is always True by default, but if you do not want to follow the redirection, *Accept* may be set to False, in which case the struct fails with an error. *Location* is the location to which the client is being redirected. Further control over redirection is provided in the [FollowRedirects](#followredirects-property-grpc-component) property. # SSLServerAuthentication Event ([GRPC](#grpc-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Go Syntax* ```text // GRPCSSLServerAuthenticationEventArgs carries the GRPC SSLServerAuthentication event's parameters. type GRPCSSLServerAuthenticationEventArgs struct {...} func (args *GRPCSSLServerAuthenticationEventArgs) CertEncoded() []byte func (args *GRPCSSLServerAuthenticationEventArgs) CertSubject() string func (args *GRPCSSLServerAuthenticationEventArgs) CertIssuer() string func (args *GRPCSSLServerAuthenticationEventArgs) Status() string func (args *GRPCSSLServerAuthenticationEventArgs) Accept() bool func (args *GRPCSSLServerAuthenticationEventArgs) SetAccept(value bool) // GRPCSSLServerAuthenticationEvent defines the signature of the GRPC SSLServerAuthentication event's handler function. type GRPCSSLServerAuthenticationEvent func(sender *GRPC, args *GRPCSSLServerAuthenticationEventArgs) func (obj *GRPC) GetOnSSLServerAuthenticationHandler() GRPCSSLServerAuthenticationEvent func (obj *GRPC) SetOnSSLServerAuthenticationHandler(handlerFunc GRPCSSLServerAuthenticationEvent) ``` ## 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 ([GRPC](#grpc-component) Component) Fired when secure connection progress messages are available. ## Syntax *Go Syntax* ```text // GRPCSSLStatusEventArgs carries the GRPC SSLStatus event's parameters. type GRPCSSLStatusEventArgs struct {...} func (args *GRPCSSLStatusEventArgs) Message() string // GRPCSSLStatusEvent defines the signature of the GRPC SSLStatus event's handler function. type GRPCSSLStatusEvent func(sender *GRPC, args *GRPCSSLStatusEventArgs) func (obj *GRPC) GetOnSSLStatusHandler() GRPCSSLStatusEvent func (obj *GRPC) SetOnSSLStatusHandler(handlerFunc GRPCSSLStatusEvent) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([GRPC](#grpc-component) Component) Fired when a document starts transferring (after the headers). ## Syntax *Go Syntax* ```text // GRPCStartTransferEventArgs carries the GRPC StartTransfer event's parameters. type GRPCStartTransferEventArgs struct {...} func (args *GRPCStartTransferEventArgs) Direction() int32 // GRPCStartTransferEvent defines the signature of the GRPC StartTransfer event's handler function. type GRPCStartTransferEvent func(sender *GRPC, args *GRPCStartTransferEventArgs) func (obj *GRPC) GetOnStartTransferHandler() GRPCStartTransferEvent func (obj *GRPC) SetOnStartTransferHandler(handlerFunc GRPCStartTransferEvent) ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Status Event ([GRPC](#grpc-component) Component) Fired when the HTTP status line is received from the server. ## Syntax *Go Syntax* ```text // GRPCStatusEventArgs carries the GRPC Status event's parameters. type GRPCStatusEventArgs struct {...} func (args *GRPCStatusEventArgs) HTTPVersion() string func (args *GRPCStatusEventArgs) StatusCode() int32 func (args *GRPCStatusEventArgs) Description() string // GRPCStatusEvent defines the signature of the GRPC Status event's handler function. type GRPCStatusEvent func(sender *GRPC, args *GRPCStatusEventArgs) func (obj *GRPC) GetOnStatusHandler() GRPCStatusEvent func (obj *GRPC) SetOnStatusHandler(handlerFunc GRPCStatusEvent) ``` ## Remarks *HTTPVersion* is a string containing the HTTP version string as returned from the server (e.g., "1.1"). *StatusCode* contains the HTTP status code (e.g., 200), and *Description* the associated message returned by the server (e.g., "OK"). # Transfer Event ([GRPC](#grpc-component) Component) Fired while a document transfers (delivers document). ## Syntax *Go Syntax* ```text // GRPCTransferEventArgs carries the GRPC Transfer event's parameters. type GRPCTransferEventArgs struct {...} func (args *GRPCTransferEventArgs) Direction() int32 func (args *GRPCTransferEventArgs) BytesTransferred() int64 func (args *GRPCTransferEventArgs) PercentDone() int32 func (args *GRPCTransferEventArgs) Text() []byte // GRPCTransferEvent defines the signature of the GRPC Transfer event's handler function. type GRPCTransferEvent func(sender *GRPC, args *GRPCTransferEventArgs) func (obj *GRPC) GetOnTransferHandler() GRPCTransferEvent func (obj *GRPC) SetOnTransferHandler(handlerFunc GRPCTransferEvent) ``` ## Remarks The *Text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *BytesTransferred* parameter contains the number of bytes transferred in this *Direction* since the beginning of the document text (excluding HTTP response headers). The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Config Settings ([GRPC](#grpc-component) Component) The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [Config](#config-method-grpc-component) method. ### GRPC Config Settings **ContentType**: The HTTP2 content-type header value.This configuration setting specifies the content-type header value that is sent in the request. The default value is *application/grpc+proto*. **HTTP2KeepaliveInterval**: The keepalive interval in seconds.This configuration setting specifies interval, in seconds, between HTTP2 keepalives. The keepalives are sent as an HTTP2 PING frame. The default value is *0* and keepalives will not be sent. **MessageDataHex**: The hex encoded data for the current message.This configuration setting may be queried at any time and will return the hex-encoded message data as a string. This is useful to obtain the raw message bytes in a string format that can be easily transmitted for storage or debugging purposes. This typically is useful only when it is necessary to record the raw message data for processing outside of the component. **UserAgent**: The HTTP2 user-agent header value.This configuration setting specifies the user-agent header value that is sent in the request. The default value is *grpc-cpp/20.0*. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the struct adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The struct only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the struct will accept compressed data. It then will uncompress the data it has received. The struct will handle data compressed by both gzip and deflate compression algorithms. When True, the struct adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the struct will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the struct fails with an error if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the [Authorization](#authorization-property-grpc-component) property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-grpc-component) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the struct.If set to True, the URL passed to the struct will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new [URL](#url-property-grpc-component) for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new [URL](#url-property-grpc-component) is retrieved automatically only if the URL Scheme is the same; otherwise, the struct fails with an error. **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A [Redirect](#redirect-event-grpc-component) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-grpc-component) event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the struct fails with an error instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the struct will perform a GET on the new location.The default value is False. If set to True, the struct will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the struct.This property specifies the HTTP version used by the struct. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the struct will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-grpc-component) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [FollowRedirects](#followredirects-property-grpc-component) is set to any value other than frNever, the struct will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the struct will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the struct beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [ProxyUser](#proxyuser-property-grpc-component) and [ProxyPassword](#proxypassword-property-grpc-component) are specified, this value is calculated using the algorithm specified by [ProxyAuthScheme](#proxyauthscheme-property-grpc-component). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the struct.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the struct. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the struct will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the struct will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the struct will attempt to use the Proxy auto-config URL when establishing a connection and [ProxyAutoDetect](#proxyautodetect-property-grpc-component) is set to *True*. When *True* (default), the struct will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [Timeout](#timeout-property-grpc-component) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The LocalHost setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the 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). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by 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. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-grpc-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-grpc-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-grpc-component) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the struct will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the struct is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-grpc-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error. When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error. When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-grpc-component) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-grpc-component) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-grpc-component) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-grpc-component) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-grpc-component) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-grpc-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-grpc-component) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the struct when the [SSLProvider](#sslprovider-property-grpc-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-grpc-component) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-grpc-component) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-grpc-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-grpc-component) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-grpc-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-grpc-component) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-grpc-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-grpc-component) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-grpc-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([GRPC](#grpc-component) Component) ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in [URL](#url-property-grpc-component). | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | The class may also return one of the following error codes, which are inherited from other classes. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the LocalHost at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the struct is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |