- com
- pcbsys
- nirvana
- nAdminAPI
- nSSLInterfaceAPI
This interface is used to expose the SSL attributes for all interfaces that are SSL enabled. More...
#include <nSSLInterfaceAPI.h>
Public Member Functions | |
| virtual const std::string & | getAlias ()=0 |
| Returns the certificate name/alias that this interface uses as its primary certificate. More... | |
| virtual bool | getCertRequired ()=0 |
| Returns whether this interface requires SSL client authentication or not. More... | |
| virtual const std::string & | getCRLFile ()=0 |
| Returns the Certificate revocation list that the server uses. More... | |
| virtual const std::string & | getCRLValidationClassName ()=0 |
| Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management. More... | |
| virtual std::string * | getEnabledCiphers (int &nCipher)=0 |
| Returns an array of strings which represent the current Ciphers enabled for use by this interface. More... | |
| virtual const std::string & | getKeyStore ()=0 |
| Returns the name of the keystore file that this interface uses to load the certificate from. More... | |
| virtual const std::string | getPKCS11ConfigFile ()=0 |
| Get the PKCS11 configuration file used by this SSL interface on the UM server. More... | |
| virtual const std::string | getPKCS11NSSName ()=0 |
| Get the PKCS11 NSS name that unique identifies the PKCS11 configuration on the UM server. More... | |
| virtual const std::string & | getProvider ()=0 |
| Get the name of the JSSE provider used by this SSL interface. More... | |
| virtual const std::string & | getRandomAlgorithm ()=0 |
| Returns the SecureRandom algoritm used for this interface. More... | |
| virtual const std::string & | getRandomProvider ()=0 |
| Returns the SecureRandom provider used by this interface. More... | |
| virtual std::string * | getSupportedCiphers (int &nCipher)=0 |
| Returns an array of ciphers this this interface can be configured for use by this interface. More... | |
| virtual const std::string & | getTrustStore ()=0 |
| Returns the current truststore file that this interface uses to validate the client certificate chain against. More... | |
| virtual void | setAlias (const std::string &alias)=0 |
| Sets the certificate name/alias that this interface will use to select its certificate from a keystore with multpiple entries. More... | |
| virtual void | setCertRequired (bool required)=0 |
| Specifies whether this interface requires SSL client authentication or not. More... | |
| virtual void | setCRLFile (const std::string &fileName)=0 |
| Sets the Certificate revocation list file name that the interface should use to check the incomming ssl connections. More... | |
| virtual void | setCRLValidationClassName (const std::string &className)=0 |
| Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management. More... | |
| virtual void | setEnabledCiphers (std::string *pCiphers, int nCipher)=0 |
| Specifies the names of the ciphers enabled for use by this interface. More... | |
| virtual void | setKeyStore (const std::string &keyStore)=0 |
| Sets the keystore file that this interface uses to load the certificate from. More... | |
| virtual void | setKeyStorePassword (const std::string &keyStorePassword)=0 |
| Sets the keystore password that this interface will use to access the keystore file specified. More... | |
| virtual void | setPKCS11ConfigFile (const std::string location)=0 |
| Sets the name of the PKCS11 configuration used by this SSL interface on the UM server. More... | |
| virtual void | setPKCS11NSSName (const std::string name)=0 |
| Sets the name of the PKCS11 NSS name that uniquely identifies the PKCS11 configuration on the UM server. More... | |
| virtual void | setPrivateKeyPassword (const std::string &password)=0 |
| Sets the private key password so that the key can be loaded from the key store. More... | |
| virtual void | setProvider (const std::string &providerName)=0 |
| Sets the name of the JSSE provider to use for the interface. More... | |
| virtual void | setRandomAlgorithm (const std::string &alg)=0 |
| Sets the SecureRandom algorithm to use for this interface. More... | |
| virtual void | setRandomProvider (const std::string &prov)=0 |
| Sets the SecureRandom provider to use for this interface. More... | |
| virtual void | setTrustStore (const std::string &trustStore)=0 |
| Sets the truststore file that this interface uses to validate the client certificate against. More... | |
| virtual void | setTrustStorePassword (const std::string &trustStorePassword)=0 |
| Changes the truststore's password that the server uses to access the trust store. More... | |
This interface is used to expose the SSL attributes for all interfaces that are SSL enabled.
If a class implements this interface it means that they support the listed API's and that SSL is active.
|
pure virtual |
Returns the certificate name/alias that this interface uses as its primary certificate.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Returns whether this interface requires SSL client authentication or not.
If this is set to false then this interface allows anonymous connections using SSL. Otherwise the client must have and present a valid certificate chain during the SSL handshake.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Returns the Certificate revocation list that the server uses.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management.
The class name can be supplied per interface and then when a client connects a callout is issued to this class to validate the connection.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Returns an array of strings which represent the current Ciphers enabled for use by this interface.
| nCipher | integer to hold the size of the array |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Returns the name of the keystore file that this interface uses to load the certificate from.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Get the PKCS11 configuration file used by this SSL interface on the UM server.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Get the PKCS11 NSS name that unique identifies the PKCS11 configuration on the UM server.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Get the name of the JSSE provider used by this SSL interface.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Returns the SecureRandom algoritm used for this interface.
If it is null it uses the system default algorithm.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Returns the SecureRandom provider used by this interface.
If it is null it uses the system default provider.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Returns an array of ciphers this this interface can be configured for use by this interface.
If the cipher is not in this list then the interface can not support it.
| an | int in which to write the size of the array |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Returns the current truststore file that this interface uses to validate the client certificate chain against.
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the certificate name/alias that this interface will use to select its certificate from a keystore with multpiple entries.
| alias | the name/alias to use as a String |
| nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Specifies whether this interface requires SSL client authentication or not.
If this is set to false then this interface allows anonymous connections using SSL. Otherwise the client must have and present a valid certificate chain during the SSL handshake.
| required | a bool specifying if this interface will force client authentication |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the Certificate revocation list file name that the interface should use to check the incomming ssl connections.
Is only used when client certificates are required.
The file should be in a standard X.509 Certificate Revocation List (CRL)
| fileName | the CRL file name that the interface uses |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management.
The class name can be supplied per interface and then when a client connects a callout is issued to this class to validate the connection.
| className | the classname of the certificate validator to use within this interface |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Specifies the names of the ciphers enabled for use by this interface.
| ciphers | a pointer to an array of ciphers enabled for use by this interface |
| size | of this array |
| nAdminIllegalArgumentException | if an empty or null array is specified |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the keystore file that this interface uses to load the certificate from.
| keyStore | the new keystore name as a String |
| nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the keystore password that this interface will use to access the keystore file specified.
| keyStorePassword | the new password as a string |
| nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the name of the PKCS11 configuration used by this SSL interface on the UM server.
| location | the location/path of the PKCS11 configuration file. |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the name of the PKCS11 NSS name that uniquely identifies the PKCS11 configuration on the UM server.
| name | The NSS name of the PKCS11 configuration file. |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the private key password so that the key can be loaded from the key store.
| password | for the private key as a String |
| nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the name of the JSSE provider to use for the interface.
| providerName | the name of the JSSE provider to use |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the SecureRandom algorithm to use for this interface.
| alg | the name of the new SecureRandom algorithm to use |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the SecureRandom provider to use for this interface.
| prov | the name of the new SecureRandom provider to use |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Sets the truststore file that this interface uses to validate the client certificate against.
| trustStore | the new truststore file to use |
| nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.
|
pure virtual |
Changes the truststore's password that the server uses to access the trust store.
| trustStorePassword | the new password to use as a String |
| nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com::pcbsys::nirvana::nAdminAPI::nSSLInterface, and com::pcbsys::nirvana::nAdminAPI::nHTTPSInterface.