# RADIUS Component The RADIUS class provides an easy way to authenticate users. ## Syntax ```text ipworksauth.RADIUS ``` ## Remarks The RADIUS component implements support for Remote Authentication Dial In User Service (RADIUS). Communication can be performed over UDP or DTLS, which is controlled by the value of the [SSLEnabled](#sslenabled-property-radius-component) property. **Authentication** The struct can be used to authenticate users with a RADIUS server. To begin set the following properties: - [RemoteHost](#remotehost-property-radius-component) - [RemotePort](#remoteport-property-radius-component) (optional) - [User](#user-property-radius-component) - [Password](#password-property-radius-component) - [SharedSecret](#sharedsecret-property-radius-component) To authenticate the user call [Authenticate](#authenticate-method-radius-component). If the method returns without error the user was successfully authenticated. The Attributes collection will hold information about the attributes in the response. The [AuthMechanism](#authmechanism-property-radius-component) property may be set to specify the authentication mechanism used. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AttrCount](#attrcount-property-radius-component) | The number of records in the Attr arrays. | | [AttrType](#attrtype-property-radius-component) | The type of the attribute. | | [AttrName](#attrname-property-radius-component) | A text description of the attribute type. | | [AttrValue](#attrvalue-property-radius-component) | The attribute value. | | [AuthMechanism](#authmechanism-property-radius-component) | The authentication mechanism to be used when connecting to the RADIUS server. | | [EAPAnonymousIdentity](#eapanonymousidentity-property-radius-component) | The identity to use when using PEAP or EAP-TLS. | | [LocalHost](#localhost-property-radius-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LocalPort](#localport-property-radius-component) | This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds. | | [Password](#password-property-radius-component) | The user's password. | | [RemoteHost](#remotehost-property-radius-component) | This property includes the address of the remote host. Domain names are resolved to IP addresses. | | [RemotePort](#remoteport-property-radius-component) | The port for the RADIUS server (default is 1812). | | [SharedSecret](#sharedsecret-property-radius-component) | The RADIUS shared secret. | | [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-radius-component) | The date on which this certificate becomes valid. | | [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-radius-component) | The date on which the certificate expires. | | [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-radius-component) | A comma-delimited list of extended key usage identifiers. | | [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-radius-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-radius-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-radius-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-radius-component) | The issuer of the certificate. | | [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-radius-component) | The private key of the certificate (if available). | | [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-radius-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-radius-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-radius-component) | The public key of the certificate. | | [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-radius-component) | The textual description of the certificate's public key algorithm. | | [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-radius-component) | The length of the certificate's public key (in bits). | | [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-radius-component) | The serial number of the certificate encoded as a string. | | [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-radius-component) | The text description of the certificate's signature algorithm. | | [SSLAcceptServerCertStore](#sslacceptservercertstore-property-radius-component) | The name of the certificate store for the client certificate. | | [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-radius-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-radius-component) | The type of certificate store for this certificate. | | [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-radius-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-radius-component) | The MD5 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-radius-component) | The SHA-1 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-radius-component) | The SHA-256 hash of the certificate. | | [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-radius-component) | The text description of UsageFlags . | | [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-radius-component) | The flags that show intended use for the certificate. | | [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-radius-component) | The certificate's version number. | | [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-radius-component) | The subject of the certificate used for client authentication. | | [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-radius-component) | The certificate (PEM/Base64 encoded). | | [SSLCertEffectiveDate](#sslcerteffectivedate-property-radius-component) | The date on which this certificate becomes valid. | | [SSLCertExpirationDate](#sslcertexpirationdate-property-radius-component) | The date on which the certificate expires. | | [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-radius-component) | A comma-delimited list of extended key usage identifiers. | | [SSLCertFingerprint](#sslcertfingerprint-property-radius-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-radius-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-radius-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLCertIssuer](#sslcertissuer-property-radius-component) | The issuer of the certificate. | | [SSLCertPrivateKey](#sslcertprivatekey-property-radius-component) | The private key of the certificate (if available). | | [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-radius-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-radius-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLCertPublicKey](#sslcertpublickey-property-radius-component) | The public key of the certificate. | | [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-radius-component) | The textual description of the certificate's public key algorithm. | | [SSLCertPublicKeyLength](#sslcertpublickeylength-property-radius-component) | The length of the certificate's public key (in bits). | | [SSLCertSerialNumber](#sslcertserialnumber-property-radius-component) | The serial number of the certificate encoded as a string. | | [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-radius-component) | The text description of the certificate's signature algorithm. | | [SSLCertStore](#sslcertstore-property-radius-component) | The name of the certificate store for the client certificate. | | [SSLCertStorePassword](#sslcertstorepassword-property-radius-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLCertStoreType](#sslcertstoretype-property-radius-component) | The type of certificate store for this certificate. | | [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-radius-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-radius-component) | The MD5 hash of the certificate. | | [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-radius-component) | The SHA-1 hash of the certificate. | | [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-radius-component) | The SHA-256 hash of the certificate. | | [SSLCertUsage](#sslcertusage-property-radius-component) | The text description of UsageFlags . | | [SSLCertUsageFlags](#sslcertusageflags-property-radius-component) | The flags that show intended use for the certificate. | | [SSLCertVersion](#sslcertversion-property-radius-component) | The certificate's version number. | | [SSLCertSubject](#sslcertsubject-property-radius-component) | The subject of the certificate used for client authentication. | | [SSLCertEncoded](#sslcertencoded-property-radius-component) | The certificate (PEM/Base64 encoded). | | [SSLEnabled](#sslenabled-property-radius-component) | This property indicates whether Datagram Transport Layer Security (DTLS) is enabled. | | [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-radius-component) | The date on which this certificate becomes valid. | | [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-radius-component) | The date on which the certificate expires. | | [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-radius-component) | A comma-delimited list of extended key usage identifiers. | | [SSLServerCertFingerprint](#sslservercertfingerprint-property-radius-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-radius-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-radius-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLServerCertIssuer](#sslservercertissuer-property-radius-component) | The issuer of the certificate. | | [SSLServerCertPrivateKey](#sslservercertprivatekey-property-radius-component) | The private key of the certificate (if available). | | [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-radius-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-radius-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLServerCertPublicKey](#sslservercertpublickey-property-radius-component) | The public key of the certificate. | | [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-radius-component) | The textual description of the certificate's public key algorithm. | | [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-radius-component) | The length of the certificate's public key (in bits). | | [SSLServerCertSerialNumber](#sslservercertserialnumber-property-radius-component) | The serial number of the certificate encoded as a string. | | [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-radius-component) | The text description of the certificate's signature algorithm. | | [SSLServerCertStore](#sslservercertstore-property-radius-component) | The name of the certificate store for the client certificate. | | [SSLServerCertStorePassword](#sslservercertstorepassword-property-radius-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLServerCertStoreType](#sslservercertstoretype-property-radius-component) | The type of certificate store for this certificate. | | [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-radius-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-radius-component) | The MD5 hash of the certificate. | | [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-radius-component) | The SHA-1 hash of the certificate. | | [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-radius-component) | The SHA-256 hash of the certificate. | | [SSLServerCertUsage](#sslservercertusage-property-radius-component) | The text description of UsageFlags . | | [SSLServerCertUsageFlags](#sslservercertusageflags-property-radius-component) | The flags that show intended use for the certificate. | | [SSLServerCertVersion](#sslservercertversion-property-radius-component) | The certificate's version number. | | [SSLServerCertSubject](#sslservercertsubject-property-radius-component) | The subject of the certificate used for client authentication. | | [SSLServerCertEncoded](#sslservercertencoded-property-radius-component) | The certificate (PEM/Base64 encoded). | | [Timeout](#timeout-property-radius-component) | The timeout for the class. | | [User](#user-property-radius-component) | The name of the user to authenticate. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Authenticate](#authenticate-method-radius-component) | Authenticates the user. | | [Config](#config-method-radius-component) | Sets or retrieves a configuration setting. | | [DoEvents](#doevents-method-radius-component) | This method processes events from the internal message queue. | | [Interrupt](#interrupt-method-radius-component) | This method interrupts the current method. | | [Reset](#reset-method-radius-component) | Resets the class properties to their default values. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Attribute](#attribute-event-radius-component) | Fires for each attribute that is received. | | [Error](#error-event-radius-component) | Fired when information is available about errors during data delivery. | | [Log](#log-event-radius-component) | Fires with log information during processing. | | [SSLServerAuthentication](#sslserverauthentication-event-radius-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-radius-component) | Fired when secure connection progress messages are available. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [RequireMessageAuthenticator](#RequireMessageAuthenticator) | Whether server responses must include the Message-Authenticator attribute. | | [SendMessageAuthenticator](#SendMessageAuthenticator) | Whether to send the Message-Authenticator attribute. | | [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. | | [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. | | [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. | | [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. | | [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). | | [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). | | [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the class to be active on the same local port. | | [UseConnection](#UseConnection) | Determines whether to use a connected socket. | | [UseIPv6](#UseIPv6) | Whether or not to use IPv6. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged. | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | Specifies the cipher suites to be used during TLS negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AttrCount Property ([RADIUS](#radius-component) Component) The number of records in the Attr arrays. ## Syntax *Go Syntax* ```text func (obj *RADIUS) AttrCount() (int32, error)func (obj *RADIUS) SetAttrCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [AttrName](#attrname-property-radius-component) - [AttrType](#attrtype-property-radius-component) - [AttrValue](#attrvalue-property-radius-component) The array indices start at *0* and end at *AttrCount - 1*. ## Data Type **int32** # AttrType Property ([RADIUS](#radius-component) Component) The type of the attribute. ## Syntax *Go Syntax* ```text func (obj *RADIUS) AttrType(AttrIndex int32) (int32, error)func (obj *RADIUS) SetAttrType(AttrIndex int32, value int32) error ``` ## Default Value 0 ## Remarks The type of the attribute. This property identifies the type of the attribute. Common values are: | AttributeType | Meaning | | --- | --- | | 1 | User-Name | | 2 | User-Password | | 3 | CHAP-Password | | 4 | NAS-IP-Address | | 5 | NAS-Port | | 6 | Service-Type | | 7 | Framed-Protocol | | 8 | Framed-IP-Address | | 9 | Framed-IP-Netmask | | 10 | Framed-Routing | | 11 | Filter-Id | | 12 | Framed-MTU | | 13 | Framed-Compression | | 14 | Login-IP-Host | | 15 | Login-Service | | 16 | Login-TCP-Port | | 17 | (unassigned) | | 18 | Reply-Message | | 19 | Callback-Number | | 20 | Callback-Id | | 21 | (unassigned) | | 22 | Framed-Route | | 23 | Framed-IPX-Network | | 24 | State | | 25 | Class | | 26 | Vendor-Specific | | 27 | Session-Timeout | | 28 | Idle-Timeout | | 29 | Termination-Action | | 30 | Called-Station-Id | | 31 | Calling-Station-Id | | 32 | NAS-Identifier | | 33 | Proxy-State | | 34 | Login-LAT-Service | | 35 | Login-LAT-Node | | 36 | Login-LAT-Group | | 37 | Framed-AppleTalk-Link | | 38 | Framed-AppleTalk-Network | | 39 | Framed-AppleTalk-Zone | | 40-59 | Reserved for accounting | | 60 | CHAP-Challenge | | 61 | NAS-Port-Type | | 62 | Port-Limit | | 63 | Login-LAT-Port | The *AttrIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttrCount](#attrcount-property-radius-component) property. ## Data Type **int32** # AttrName Property ([RADIUS](#radius-component) Component) A text description of the attribute type. ## Syntax *Go Syntax* ```text func (obj *RADIUS) AttrName(AttrIndex int32) (string, error) ``` ## Default Value "" ## Remarks A text description of the attribute type. This property holds a text description of the [AttributeType](#RADIUS_p_AttributeType). The *AttrIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttrCount](#attrcount-property-radius-component) property. This property is read-only. ## Data Type **string** # AttrValue Property ([RADIUS](#radius-component) Component) The attribute value. ## Syntax *Go Syntax* ```text func (obj *RADIUS) AttrValue(AttrIndex int32) ([]byte, error)func (obj *RADIUS) SetAttrValue(AttrIndex int32, value []byte) error ``` ## Default Value "" ## Remarks The attribute value. The *AttrIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttrCount](#attrcount-property-radius-component) property. ## Data Type **[]byte** # AuthMechanism Property ([RADIUS](#radius-component) Component) The authentication mechanism to be used when connecting to the RADIUS server. ## Syntax *Go Syntax* ```text func (obj *RADIUS) AuthMechanism() (int32, error)func (obj *RADIUS) SetAuthMechanism(value int32) error ``` ## Possible Values ```text 0 // MSCHAPv21 // PAP2 // PEAPv03 // EAPTLS ``` ## Default Value 0 ## Remarks This property defines the authentication mechanism used when connecting to the RADIUS server. Possible values are: | | | | --- | --- | | 0 (ramMSCHAPv2 - default) | Microsoft Challenge Authentication Protocol v2 | | 1 (ramPAP) | Password Authentication Protocol | | 2 (ramPEAPv0) | Protected Extensible Authentication Protocol with MSCHAPv2 inner authentication | | 3 (ramEAPTLS) | Extensible Authentication Protocol with TLS. When set to ramEAPTLS the SSLCert property must be set to the client certificate used to authenticate to the server. | ## Data Type **int32** # EAPAnonymousIdentity Property ([RADIUS](#radius-component) Component) The identity to use when using PEAP or EAP-TLS. ## Syntax *Go Syntax* ```text func (obj *RADIUS) EAPAnonymousIdentity() (string, error)func (obj *RADIUS) SetEAPAnonymousIdentity(value string) error ``` ## Default Value "anonymous" ## Remarks This property specifies the initial identity to use when establishing a secure connection using PEAP. When [AuthMechanism](#authmechanism-property-radius-component) is set to *amPEAPv0* or *emEAPTLS* the connection begins in plaintext. This property specifies the user name (if any) that is sent in the initial plaintext request. This allows the true identity of the user to be hidden. If set, the value will be sent in the plaintext connection request. If not set (empty string) the [User](#user-property-radius-component) will be sent. Authentication servers may make use of a value that includes the domain to which the user will authenticate, such as *anonymous@example.com*. In that case the user's identity is still hidden, however the authentication server will have knowledge of the domain for the user which it may make use of. Once a secure connection is established the user's true identity is sent to the authentication server over the TLS encrypted connection. This property specifies only the identity sent in the initial plaintext request. The default value is *anonymous*. This setting is only applicable when [AuthMechanism](#authmechanism-property-radius-component) is set to *amPEAPv0* or *amEAPTLS*. ## Data Type **string** # LocalHost Property ([RADIUS](#radius-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Go Syntax* ```text func (obj *RADIUS) LocalHost() (string, error)func (obj *RADIUS) SetLocalHost(value string) error ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the struct is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. ## Data Type **string** # LocalPort Property ([RADIUS](#radius-component) Component) This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds. ## Syntax *Go Syntax* ```text func (obj *RADIUS) LocalPort() (int32, error)func (obj *RADIUS) SetLocalPort(value int32) error ``` ## Default Value 0 ## Remarks The LocalPort property must be set before UDP is activated (Active is set to True). This instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting it to *0* (default) enables the Transmission Control Protocol (TCP)/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established. LocalPort cannot be changed once the struct is Active. Any attempt to set the LocalPort property when the struct is Active will generate an error. The LocalPort property is useful when trying to connect to services that require a trusted port on the client side. ## Data Type **int32** # Password Property ([RADIUS](#radius-component) Component) The user's password. ## Syntax *Go Syntax* ```text func (obj *RADIUS) Password() (string, error)func (obj *RADIUS) SetPassword(value string) error ``` ## Default Value "" ## Remarks This property specifies the password for the [User](#user-property-radius-component). This must be set before calling [Authenticate](#authenticate-method-radius-component). ## Data Type **string** # RemoteHost Property ([RADIUS](#radius-component) Component) This property includes the address of the remote host. Domain names are resolved to IP addresses. ## Syntax *Go Syntax* ```text func (obj *RADIUS) RemoteHost() (string, error)func (obj *RADIUS) SetRemoteHost(value string) error ``` ## Default Value "" ## Remarks The RemoteHost property specifies the IP address (IP number in dotted internet format) or domain name of the remote host. If RemoteHost is set to 255.255.255.255, the struct broadcasts data on the local subnet. If the RemoteHost property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the RemoteHost property is set to the corresponding address. If the search is not successful, an error is returned. If [UseConnection](#UseConnection) is set to True, the RemoteHost must be set before the struct is activated (Active is set to True). ## Data Type **string** # RemotePort Property ([RADIUS](#radius-component) Component) The port for the RADIUS server (default is 1812). ## Syntax *Go Syntax* ```text func (obj *RADIUS) RemotePort() (int32, error)func (obj *RADIUS) SetRemotePort(value int32) error ``` ## Default Value 1812 ## Remarks The RemotePort is the UDP port to which requests will be made. The default value is 1812. Port 1645 is also commonly used. ## Data Type **int32** # SharedSecret Property ([RADIUS](#radius-component) Component) The RADIUS shared secret. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SharedSecret() ([]byte, error)func (obj *RADIUS) SetSharedSecret(value []byte) error ``` ## Default Value "" ## Remarks This property holds the shared secret to use when communicating with the RADIUS server. ## Data Type **[]byte** # SSLAcceptServerCertEffectiveDate Property ([RADIUS](#radius-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertEffectiveDate() (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** # SSLAcceptServerCertExpirationDate Property ([RADIUS](#radius-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertExpirationDate() (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** # SSLAcceptServerCertExtendedKeyUsage Property ([RADIUS](#radius-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertExtendedKeyUsage() (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** # SSLAcceptServerCertFingerprint Property ([RADIUS](#radius-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertFingerprint() (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** # SSLAcceptServerCertFingerprintSHA1 Property ([RADIUS](#radius-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertFingerprintSHA1() (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** # SSLAcceptServerCertFingerprintSHA256 Property ([RADIUS](#radius-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertFingerprintSHA256() (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** # SSLAcceptServerCertIssuer Property ([RADIUS](#radius-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertIssuer() (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** # SSLAcceptServerCertPrivateKey Property ([RADIUS](#radius-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-radius-component) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-radius-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPrivateKeyAvailable Property ([RADIUS](#radius-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-radius-component) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-radius-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLAcceptServerCertPrivateKeyContainer Property ([RADIUS](#radius-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-radius-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type **string** # SSLAcceptServerCertPublicKey Property ([RADIUS](#radius-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertPublicKey() (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** # SSLAcceptServerCertPublicKeyAlgorithm Property ([RADIUS](#radius-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertPublicKeyAlgorithm() (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** # SSLAcceptServerCertPublicKeyLength Property ([RADIUS](#radius-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertPublicKeyLength() (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** # SSLAcceptServerCertSerialNumber Property ([RADIUS](#radius-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertSerialNumber() (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** # SSLAcceptServerCertSignatureAlgorithm Property ([RADIUS](#radius-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertSignatureAlgorithm() (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** # SSLAcceptServerCertStore Property ([RADIUS](#radius-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertStore() ([]byte, error)func (obj *RADIUS) SetSSLAcceptServerCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-radius-component) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-radius-component). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-radius-component). [SSLAcceptServerCertStore](#sslacceptservercertstore-property-radius-component) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-radius-component) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-radius-component) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-radius-component) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-radius-component) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-radius-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** # SSLAcceptServerCertStorePassword Property ([RADIUS](#radius-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 *RADIUS) SSLAcceptServerCertStorePassword() (string, error)func (obj *RADIUS) SetSSLAcceptServerCertStorePassword(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** # SSLAcceptServerCertStoreType Property ([RADIUS](#radius-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertStoreType() (int32, error)func (obj *RADIUS) SetSSLAcceptServerCertStoreType(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 [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-radius-component), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-radius-component), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-radius-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-radius-component) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-radius-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 ([RADIUS](#radius-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-radius-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 ([RADIUS](#radius-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-radius-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-radius-component) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-radius-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLAcceptServerCertVersion Property ([RADIUS](#radius-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertSubject() (string, error)func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLAcceptServerCertEncoded() ([]byte, error)func (obj *RADIUS) 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-radius-component) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-radius-component) properties also may be used to specify a certificate. When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-radius-component) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-radius-component) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-radius-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-radius-component) is set to an empty string. ## Data Type **[]byte** # SSLCertEffectiveDate Property ([RADIUS](#radius-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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-radius-component) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-radius-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLCertPrivateKeyAvailable Property ([RADIUS](#radius-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-radius-component) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-radius-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 ([RADIUS](#radius-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-radius-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 ([RADIUS](#radius-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLCertStore() ([]byte, error)func (obj *RADIUS) SetSSLCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-radius-component) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-radius-component). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-radius-component). [SSLCertStore](#sslcertstore-property-radius-component) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-radius-component) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-radius-component) has a value, and [SSLCertSubject](#sslcertsubject-property-radius-component) or [SSLCertEncoded](#sslcertencoded-property-radius-component) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-radius-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 ([RADIUS](#radius-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 *RADIUS) SSLCertStorePassword() (string, error)func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLCertStoreType() (int32, error)func (obj *RADIUS) 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-radius-component), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-radius-component), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-radius-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-radius-component) and set [SSLCertStorePassword](#sslcertstorepassword-property-radius-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 ([RADIUS](#radius-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-radius-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 ([RADIUS](#radius-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-radius-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-radius-component) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-radius-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLCertVersion Property ([RADIUS](#radius-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLCertSubject() (string, error)func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLCertEncoded() ([]byte, error)func (obj *RADIUS) 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-radius-component) and [SSLCertSubject](#sslcertsubject-property-radius-component) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-radius-component) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-radius-component) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-radius-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-radius-component) is set to an empty string. ## Data Type **[]byte** # SSLEnabled Property ([RADIUS](#radius-component) Component) This property indicates whether Datagram Transport Layer Security (DTLS) is enabled. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLEnabled() (bool, error)func (obj *RADIUS) SetSSLEnabled(value bool) error ``` ## Default Value false ## Remarks This property specifies whether DTLS is enabled in the struct. When *false* (default), the struct operates in plaintext mode over UDP. When *true*, DTLS is enabled. ## Data Type **bool** # SSLServerCertEffectiveDate Property ([RADIUS](#radius-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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-radius-component) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-radius-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLServerCertPrivateKeyAvailable Property ([RADIUS](#radius-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLServerCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-radius-component) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-radius-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 ([RADIUS](#radius-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLServerCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-radius-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 ([RADIUS](#radius-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLServerCertStore() ([]byte, error) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLServerCertStoreType](#sslservercertstoretype-property-radius-component) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-radius-component). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-radius-component). [SSLServerCertStore](#sslservercertstore-property-radius-component) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-radius-component) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-radius-component) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-radius-component) or [SSLServerCertEncoded](#sslservercertencoded-property-radius-component) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-radius-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 ([RADIUS](#radius-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 *RADIUS) 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 ([RADIUS](#radius-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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-radius-component), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-radius-component), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-radius-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-radius-component) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-radius-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 ([RADIUS](#radius-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLServerCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-radius-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 ([RADIUS](#radius-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLServerCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-radius-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-radius-component) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-radius-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLServerCertVersion Property ([RADIUS](#radius-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *RADIUS) 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 ([RADIUS](#radius-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *RADIUS) SSLServerCertEncoded() ([]byte, error) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-radius-component) and [SSLServerCertSubject](#sslservercertsubject-property-radius-component) properties also may be used to specify a certificate. When [SSLServerCertEncoded](#sslservercertencoded-property-radius-component) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-radius-component) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-radius-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-radius-component) is set to an empty string. This property is read-only. ## Data Type **[]byte** # Timeout Property ([RADIUS](#radius-component) Component) The timeout for the class. ## Syntax *Go Syntax* ```text func (obj *RADIUS) Timeout() (int32, error)func (obj *RADIUS) 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-radius-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** # User Property ([RADIUS](#radius-component) Component) The name of the user to authenticate. ## Syntax *Go Syntax* ```text func (obj *RADIUS) User() (string, error)func (obj *RADIUS) SetUser(value string) error ``` ## Default Value "" ## Remarks This property holds the name of the user to authenticate. ## Data Type **string** # Authenticate Method ([RADIUS](#radius-component) Component) Authenticates the user. ## Syntax *Go Syntax* ```text func (obj *RADIUS) Authenticate() error ``` ## Remarks This method authenticates the user with the RADIUS server. If authentication is successful this method returns without error. If authentication fails this method will throw an exception. This following properties are applicable when calling this method: - [User](#user-property-radius-component) (required) - [Password](#password-property-radius-component) (required) - [SharedSecret](#sharedsecret-property-radius-component) (required) - [RemoteHost](#remotehost-property-radius-component) (required) - [RemotePort](#remoteport-property-radius-component) - [Timeout](#timeout-property-radius-component) # Config Method ([RADIUS](#radius-component) Component) Sets or retrieves a configuration setting. ## Syntax *Go Syntax* ```text func (obj *RADIUS) Config(ConfigurationString string) (string, error) ``` ## Remarks Config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-radius-component) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-radius-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoEvents Method ([RADIUS](#radius-component) Component) This method processes events from the internal message queue. ## Syntax *Go Syntax* ```text func (obj *RADIUS) DoEvents() error ``` ## Remarks When DoEvents is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # Interrupt Method ([RADIUS](#radius-component) Component) This method interrupts the current method. ## Syntax *Go Syntax* ```text func (obj *RADIUS) Interrupt() error ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # Reset Method ([RADIUS](#radius-component) Component) Resets the class properties to their default values. ## Syntax *Go Syntax* ```text func (obj *RADIUS) Reset() error ``` ## Remarks This method resets the properties to their default values. # Attribute Event ([RADIUS](#radius-component) Component) Fires for each attribute that is received. ## Syntax *Go Syntax* ```text // RADIUSAttributeEventArgs carries the RADIUS Attribute event's parameters. type RADIUSAttributeEventArgs struct {...} func (args *RADIUSAttributeEventArgs) AttributeType() int32 func (args *RADIUSAttributeEventArgs) Name() string func (args *RADIUSAttributeEventArgs) Value() []byte // RADIUSAttributeEvent defines the signature of the RADIUS Attribute event's handler function. type RADIUSAttributeEvent func(sender *RADIUS, args *RADIUSAttributeEventArgs) func (obj *RADIUS) GetOnAttributeHandler() RADIUSAttributeEvent func (obj *RADIUS) SetOnAttributeHandler(handlerFunc RADIUSAttributeEvent) ``` ## Remarks This event fires once for each attribute that is received. This will fire when calling [Authenticate](#authenticate-method-radius-component). **AttributeType** is the attribute type. Common values are: | AttributeType | Meaning | | --- | --- | | 1 | User-Name | | 2 | User-Password | | 3 | CHAP-Password | | 4 | NAS-IP-Address | | 5 | NAS-Port | | 6 | Service-Type | | 7 | Framed-Protocol | | 8 | Framed-IP-Address | | 9 | Framed-IP-Netmask | | 10 | Framed-Routing | | 11 | Filter-Id | | 12 | Framed-MTU | | 13 | Framed-Compression | | 14 | Login-IP-Host | | 15 | Login-Service | | 16 | Login-TCP-Port | | 17 | (unassigned) | | 18 | Reply-Message | | 19 | Callback-Number | | 20 | Callback-Id | | 21 | (unassigned) | | 22 | Framed-Route | | 23 | Framed-IPX-Network | | 24 | State | | 25 | Class | | 26 | Vendor-Specific | | 27 | Session-Timeout | | 28 | Idle-Timeout | | 29 | Termination-Action | | 30 | Called-Station-Id | | 31 | Calling-Station-Id | | 32 | NAS-Identifier | | 33 | Proxy-State | | 34 | Login-LAT-Service | | 35 | Login-LAT-Node | | 36 | Login-LAT-Group | | 37 | Framed-AppleTalk-Link | | 38 | Framed-AppleTalk-Network | | 39 | Framed-AppleTalk-Zone | | 40-59 | Reserved for accounting | | 60 | CHAP-Challenge | | 61 | NAS-Port-Type | | 62 | Port-Limit | | 63 | Login-LAT-Port | **Name** is the text description of the attribute. **Value** is the value of the attribute. # Error Event ([RADIUS](#radius-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Go Syntax* ```text // RADIUSErrorEventArgs carries the RADIUS Error event's parameters. type RADIUSErrorEventArgs struct {...} func (args *RADIUSErrorEventArgs) ErrorCode() int32 func (args *RADIUSErrorEventArgs) Description() string // RADIUSErrorEvent defines the signature of the RADIUS Error event's handler function. type RADIUSErrorEvent func(sender *RADIUS, args *RADIUSErrorEventArgs) func (obj *RADIUS) GetOnErrorHandler() RADIUSErrorEvent func (obj *RADIUS) SetOnErrorHandler(handlerFunc RADIUSErrorEvent) ``` ## 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-radius-component) section. # Log Event ([RADIUS](#radius-component) Component) Fires with log information during processing. ## Syntax *Go Syntax* ```text // RADIUSLogEventArgs carries the RADIUS Log event's parameters. type RADIUSLogEventArgs struct {...} func (args *RADIUSLogEventArgs) LogLevel() int32 func (args *RADIUSLogEventArgs) Message() string func (args *RADIUSLogEventArgs) LogType() string // RADIUSLogEvent defines the signature of the RADIUS Log event's handler function. type RADIUSLogEvent func(sender *RADIUS, args *RADIUSLogEventArgs) func (obj *RADIUS) GetOnLogHandler() RADIUSLogEvent func (obj *RADIUS) SetOnLogHandler(handlerFunc RADIUSLogEvent) ``` ## Remarks This event fires during processing with log information. The level of detail that is logged is controlled via the [LogLevel](#LogLevel). *LogLevel* indicates the level of message. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | *LogMessage* is the log entry. *LogType* indicates the type of log. Possible values are: - "REQUEST" - "RESPONSE" # SSLServerAuthentication Event ([RADIUS](#radius-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Go Syntax* ```text // RADIUSSSLServerAuthenticationEventArgs carries the RADIUS SSLServerAuthentication event's parameters. type RADIUSSSLServerAuthenticationEventArgs struct {...} func (args *RADIUSSSLServerAuthenticationEventArgs) CertEncoded() []byte func (args *RADIUSSSLServerAuthenticationEventArgs) CertSubject() string func (args *RADIUSSSLServerAuthenticationEventArgs) CertIssuer() string func (args *RADIUSSSLServerAuthenticationEventArgs) Status() string func (args *RADIUSSSLServerAuthenticationEventArgs) Accept() bool func (args *RADIUSSSLServerAuthenticationEventArgs) SetAccept(value bool) // RADIUSSSLServerAuthenticationEvent defines the signature of the RADIUS SSLServerAuthentication event's handler function. type RADIUSSSLServerAuthenticationEvent func(sender *RADIUS, args *RADIUSSSLServerAuthenticationEventArgs) func (obj *RADIUS) GetOnSSLServerAuthenticationHandler() RADIUSSSLServerAuthenticationEvent func (obj *RADIUS) SetOnSSLServerAuthenticationHandler(handlerFunc RADIUSSSLServerAuthenticationEvent) ``` ## 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 ([RADIUS](#radius-component) Component) Fired when secure connection progress messages are available. ## Syntax *Go Syntax* ```text // RADIUSSSLStatusEventArgs carries the RADIUS SSLStatus event's parameters. type RADIUSSSLStatusEventArgs struct {...} func (args *RADIUSSSLStatusEventArgs) Message() string // RADIUSSSLStatusEvent defines the signature of the RADIUS SSLStatus event's handler function. type RADIUSSSLStatusEvent func(sender *RADIUS, args *RADIUSSSLStatusEventArgs) func (obj *RADIUS) GetOnSSLStatusHandler() RADIUSSSLStatusEvent func (obj *RADIUS) SetOnSSLStatusHandler(handlerFunc RADIUSSSLStatusEvent) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # Config Settings ([RADIUS](#radius-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-radius-component) method. ### RADIUS Config Settings **RequireMessageAuthenticator**: Whether server responses must include the Message-Authenticator attribute.This setting specifies whether the Message-Authenticator attribute must be included in server responses. The Message-Authenticator attribute allows integrity checking of the response packet, which increases security. When set to *true* (default) if a server response does not include the attribute the packet will be ignored. If set to *false* the attribute is not required to be present in server responses. **SendMessageAuthenticator**: Whether to send the Message-Authenticator attribute.This setting specifies whether the Message-Authenticator attribute is sent. The default value is *true*. In most cases there is no reason to set this to *false*. When *true*, authentication can succeed whether the RADIUS server requires the Message-Authenticator attribute or not. ### UDP Config Settings **CaptureIPPacketInfo**: Used to capture the packet information.If this is set to True, the component will capture the IP packet information. The default value for this setting is False. NOTE: This configuration setting is available only in Windows. **DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when [RemoteHost](#remotehost-property-radius-component) is set. If *true* the struct will resolve the hostname and the IP address will be present in the [RemoteHost](#remotehost-property-radius-component) property. If *false*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may be called to manually resolve the value in [RemoteHost](#remotehost-property-radius-component) at any time. The default value is *false*. **DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event. NOTE: This configuration setting is available only in Windows. **DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the struct will have the Don't Fragment flag set. The default value is False. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-radius-component) 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](#localhost-property-radius-component) 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](#localport-property-radius-component) after the connection is established. [LocalPort](#localport-property-radius-component) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the struct will accept without truncation. **QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).[UseConnection](#UseConnection) must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value. NOTE: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later. **QOSTrafficType**: Used to specify QOS/DSCP settings (optional).[UseConnection](#UseConnection) must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5). NOTE: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above. NOTE: QOSTrafficType must be set before setting Active to True. **ShareLocalPort**: If set to True, allows more than one instance of the struct to be active on the same local port.This option must be set before the struct is activated through the Active property or it will have no effect. The default value for this setting is False. **UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the struct should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the struct will send and receive data to and from the specified destination. The default value for this setting is False. **UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True. ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-radius-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. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged.This configuration setting controls whether 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-radius-component) event, which will fire each time a SSL packet is sent or received. **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 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-radius-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**: Specifies the cipher suites to be used during TLS negotiation.This configuration is used to specify the cipher suites to be used during TLS 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. For example: ```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 cipher suites 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 **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. The default value is *3072*. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | **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 is set to *Internal*. **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 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 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 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) ### 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 ([RADIUS](#radius-component) Component) ### RADIUS Errors | | | | --- | --- | | 900 | Busy performing other action. | | 901 | Received invalid response. | | 902 | Received rejected response. | | 903 | Received challenge response. | ### UDP Errors | | | | --- | --- | | 104 | UDP is already Active. | | 106 | You cannot change the [LocalPort](#localport-property-radius-component) while the struct is Active. | | 107 | You cannot change the [LocalHost](#localhost-property-radius-component) at this time. A connection is in progress. | | 109 | The struct must be Active for this operation. | | 112 | You cannot change [MaxPacketSize](#MaxPacketSize) while the struct is Active. | | 113 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the struct is Active. | | 114 | You cannot change [RemoteHost](#remotehost-property-radius-component) when [UseConnection](#UseConnection) is set and the struct Active. | | 115 | You cannot change [RemotePort](#remoteport-property-radius-component) when [UseConnection](#UseConnection) is set and the struct is Active. | | 116 | [RemotePort](#remoteport-property-radius-component) cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. | | 117 | You cannot change [UseConnection](#UseConnection) while the struct is Active. | | 118 | Message cannot be longer than [MaxPacketSize](#MaxPacketSize). | | 119 | Message too short. | | 434 | Unable to convert string to selected CodePage. | ### 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). |