| |
OScript API/Built-in Package Index |
The built-in functions in the SSLOptions Package allow the SMTPSession and POP3Session to communicate using SSL sockets and configure the SSL options as required.
The SSLOptions Package offers the following functionality:
Don't bother to do any cert verification
Do a relaxed cert verification. This is the default
X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH
X509_V_ERR_AKID_SKID_MISMATCH
X509_V_ERR_CERT_HAS_EXPIRED
X509_V_ERR_CERT_NOT_YET_VALID
X509_V_ERR_CERT_REJECTED
X509_V_ERR_CERT_SIGNATURE_FAILURE
X509_V_ERR_CERT_UNTRUSTED
X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD
X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD
X509_V_ERR_INVALID_CA
X509_V_ERR_INVALID_PURPOSE
X509_V_ERR_KEYUSAGE_NO_CERTSIGN
X509_V_ERR_PATH_LENGTH_EXCEEDED
X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN
X509_V_ERR_SUBJECT_ISSUER_MISMATCH
X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY
X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE
X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT
X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE
Returns a new SSLOptions class, or undefined if an error occured.
Returns the path to the certificate file.
Returns the current cipher list string.
Clears the ignored error list.
Returns a list of the errors added via [IgnoreError].
Returns a string containing the text of the last error, if any.
Tells the SSL socket negotiation to ignore the specified certificate validation error.
Returns the path to the private key file.
Returns the private key passphrase.
Returns the path to the root certificates.
Sets the path to the certificate file.
Sets the SSL verification cipher list.
Sets the path to the private key file.
Sets the private key file passphrase that was used to encrypt the private key file.
Sets the path to the root certificates.
Sets the SSL certificate verification depth.
Sets the SSL certificate verification flag.
Returns the verification depth.
Returns the current verification flag value.
Returns a new SSLOptions object
A new SSLOptions object or undefined if there was an error constructing the object.
No parameters. Returns the certificate file location string.
Returns the certificate file location string.
No parameters. Returns the current cipher list string.
Returns the current cipher list string.
No parameters. Removes all errors entered by the IgnoreError() function.
Returns 0 for success and -1 if an error occurred.
No parameters. Returns a List of Integers of the errors added via IgnoreError().
Returns a List of Integers of the errors added via IgnoreError().
No parameters. Returns an error string for the last error that occured.
Returns an error string for the last error that occured.
Sets certificate verification errors to be ignored when doing an SSL negotiation.
Any of the SSL Error Constants above.
Returns 0 for success and -1 if an error occurred.
No parameters. Returns the private key file location string.
Returns the private key file location string.
No parameters. Returns the current private key passphrase string.
Returns the current private key passphrase string.
No parameters. Returns the root certificates file location string.
Returns the root certificates file location string.
Sets the location of the local certificate file to be used for SSL negotiations. This file may also contain the private key. The expected file format is PEM.
Fully qualified filepath to the certificate file.
Returns 0 for success and -1 if an error occurred.
Don't mess with this unless you really know what you're doing. Default is "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH". Conforms to OpenSSL conventions.
cipher list to use
Returns 0 for success and -1 if an error occurred.
Sets the location of the private key file to be used for SSL negotiations.
Fully qualified filepath to the private key file.
Returns 0 for success and -1 if an error occurred.
The passphrase parameter is used if your private key file is also password encrypted.
private key passphrase.
Returns 0 for success and -1 if an error occurred.
The file parameter can be either a directory where the CA certificates are stored or a filename of a PEM format file that contains the root CA certs.
Fully qualified filepath to the certificate file or fully qualified directory path.
Returns 0 for success and -1 if an error occurred.
The depth param is a number from 1 to 9 ( the maximum depth ) for how deeply into the cert tree the validation will proceed. Default is 9.
The depth param is a number from 1 to 9 ( the maximum depth ) for how deeply into the cert tree the validation will proceed. Default is 9.
Returns 0 for success and -1 if an error occurred.
The flag parameter can be either SSLOptions.VERIFY_NONE or SSLOptions.VERIFY_RELAXED. Default is SSLOptions.VERIFY_RELAXED.
Fully qualified filepath to the certificate file or fully qualified directory path.
Returns 0 for success and -1 if an error occurred.
No parameters. Returns the current verification depth or -1 if an error occured.
Returns the current verification depth or -1 if an error occured.
No parameters. Returns the current verification flag value or -1 if an error occurred.
Returns 0 for success and -1 if an error occurred.
| Copyright © 2021 OpenText Corporation. All rights reserved. |