.NET Based OPC UA Client/Server SDK  2.6.0.418
UnifiedAutomation.UaBase.DirectoryCertificateStore Class Reference

Provides access to a directory based certificate store. More...

Inherits UnifiedAutomation.UaBase.ICertificateStore.

Public Member Functions

 DirectoryCertificateStore (string storePath)
 Initializes a new instance of the DirectoryCertificateStore class. More...
 
 DirectoryCertificateStore (string storePath, bool noPrivateKeys)
 Initializes a new instance of the DirectoryCertificateStore class. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
ICertificate Find (string thumbprint)
 Finds the specified thumbprint. More...
 
ICertificate Find (string thumbprint, bool needPrivateKey)
 Finds a certificate in the store. More...
 
ICertificate Find (string subjectName, string thumbprint, bool needPrivateKey)
 Finds a certificate in the store. More...
 
ICertificate Find (string subjectName, string thumbprint, string password)
 Finds a password protected private key in the store. More...
 
void Add (ICertificate certificate, bool replaceExisting, bool savePrivateKey)
 Adds the specified certificate to the store. More...
 
void Remove (string thumbprint)
 Removes the specified thumbprint. More...
 
StatusCode IsRevoked (ICertificate issuer, ICertificate certificate)
 Determines whether the specified certificate has been revoked by the issuer. More...
 
string GetPublicKeyFilePath (string thumbprint)
 Gets the public key file path. More...
 
string GetPrivateKeyFilePath (string thumbprint)
 Gets the private key file path. More...
 
string[] GetCrlFilePaths (string thumbprint)
 Gets the CRL file paths. More...
 
List< X509CRLEnumerateCRLs (ICertificate issuer)
 Returns the CRLs for the issuer. More...
 
void AddCRL (X509CRL crl)
 Adds a CRL to the store. More...
 
bool DeleteCRL (X509CRL crl)
 Removes a CRL from the store. More...
 
IEnumerator< ICertificateGetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 

Properties

string StoreType [get]
 Gets the store type. More...
 
string StorePath [get]
 Gets the store path. More...
 
CertificateValidationOptions ValidationOptions [get, set]
 Gets or sets the validation options. More...
 
bool NoPrivateKeys [get]
 Gets or sets a value indicating whether any private keys are found in the store. More...
 
- Properties inherited from UnifiedAutomation.UaBase.ICertificateStore
string StoreType [get]
 Gets the store type. More...
 
string StorePath [get]
 Gets the store path. More...
 
CertificateValidationOptions ValidationOptions [get, set]
 Gets or sets the validation options. More...
 

Detailed Description

Provides access to a directory based certificate store.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.DirectoryCertificateStore.DirectoryCertificateStore ( string  storePath)
inline

Initializes a new instance of the DirectoryCertificateStore class.

Parameters
storePathThe store path.
UnifiedAutomation.UaBase.DirectoryCertificateStore.DirectoryCertificateStore ( string  storePath,
bool  noPrivateKeys 
)
inline

Initializes a new instance of the DirectoryCertificateStore class.

Parameters
storePathThe store path.
noPrivateKeysif set to true [no private keys].

Member Function Documentation

void UnifiedAutomation.UaBase.DirectoryCertificateStore.Add ( ICertificate  certificate,
bool  replaceExisting,
bool  savePrivateKey 
)
inline

Adds the specified certificate to the store.

Parameters
certificateThe certificate.
replaceExistingif set to true any existing certificate is replaced.
savePrivateKeyif set to true any private key is saved as well.

Implements UnifiedAutomation.UaBase.ICertificateStore.

void UnifiedAutomation.UaBase.DirectoryCertificateStore.AddCRL ( X509CRL  crl)
inline

Adds a CRL to the store.

bool UnifiedAutomation.UaBase.DirectoryCertificateStore.DeleteCRL ( X509CRL  crl)
inline

Removes a CRL from the store.

void UnifiedAutomation.UaBase.DirectoryCertificateStore.Dispose ( )
inline

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaBase.DirectoryCertificateStore.Dispose ( bool  disposing)
inlineprotectedvirtual

An overrideable version of the Dispose.

Parameters
disposingtrue to release both managed and unmanaged resources; false to release only unmanaged resources.
List<X509CRL> UnifiedAutomation.UaBase.DirectoryCertificateStore.EnumerateCRLs ( ICertificate  issuer)
inline

Returns the CRLs for the issuer.

Parameters
issuerThe issuer.
Returns
The CRLs.
ICertificate UnifiedAutomation.UaBase.DirectoryCertificateStore.Find ( string  thumbprint)
inline

Finds the specified thumbprint.

Parameters
thumbprintThe thumbprint of the certificate.
Returns
The certificate if found, null otherwise.

Implements UnifiedAutomation.UaBase.ICertificateStore.

ICertificate UnifiedAutomation.UaBase.DirectoryCertificateStore.Find ( string  thumbprint,
bool  needPrivateKey 
)
inline

Finds a certificate in the store.

Parameters
thumbprintThe thumbprint.
needPrivateKeyif set to true the certificate is only returned if a private key is accessible.
Returns
The certificate; null if not found.

Implements UnifiedAutomation.UaBase.ICertificateStore.

ICertificate UnifiedAutomation.UaBase.DirectoryCertificateStore.Find ( string  subjectName,
string  thumbprint,
bool  needPrivateKey 
)
inline

Finds a certificate in the store.

Parameters
subjectNameThe subject name.
thumbprintThe thumbprint.
needPrivateKeyif set to true the certificate is only returned if a private key is accessible.
Returns

Implements UnifiedAutomation.UaBase.ICertificateStore.

ICertificate UnifiedAutomation.UaBase.DirectoryCertificateStore.Find ( string  subjectName,
string  thumbprint,
string  password 
)
inline

Finds a password protected private key in the store.

Parameters
subjectNameThe subject name.
thumbprintThe thumbprint.
passwordThe password.
Returns
The certificate with the private key.
string [] UnifiedAutomation.UaBase.DirectoryCertificateStore.GetCrlFilePaths ( string  thumbprint)
inline

Gets the CRL file paths.

Parameters
thumbprintThe thumbprint.
Returns
IEnumerator<ICertificate> UnifiedAutomation.UaBase.DirectoryCertificateStore.GetEnumerator ( )
inline

Returns an enumerator that iterates through the collection.

Returns
A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.
string UnifiedAutomation.UaBase.DirectoryCertificateStore.GetPrivateKeyFilePath ( string  thumbprint)
inline

Gets the private key file path.

Parameters
thumbprintThe thumbprint.
Returns
The private key file path. Null if the private key was not found.

Implements UnifiedAutomation.UaBase.ICertificateStore.

string UnifiedAutomation.UaBase.DirectoryCertificateStore.GetPublicKeyFilePath ( string  thumbprint)
inline

Gets the public key file path.

Parameters
thumbprintThe thumbprint.
Returns
StatusCode UnifiedAutomation.UaBase.DirectoryCertificateStore.IsRevoked ( ICertificate  issuer,
ICertificate  certificate 
)
inline

Determines whether the specified certificate has been revoked by the issuer.

Parameters
issuerThe issuer.
certificateThe certificate.
Returns
Good if the certificate is fine. An error status if a problem occurred.

Implements UnifiedAutomation.UaBase.ICertificateStore.

void UnifiedAutomation.UaBase.DirectoryCertificateStore.Remove ( string  thumbprint)
inline

Removes the specified thumbprint.

Parameters
thumbprintThe thumbprint.

Implements UnifiedAutomation.UaBase.ICertificateStore.

Property Documentation

bool UnifiedAutomation.UaBase.DirectoryCertificateStore.NoPrivateKeys
get

Gets or sets a value indicating whether any private keys are found in the store.

true if [no private keys]; otherwise, false.

string UnifiedAutomation.UaBase.DirectoryCertificateStore.StorePath
get

Gets the store path.

string UnifiedAutomation.UaBase.DirectoryCertificateStore.StoreType
get

Gets the store type.

CertificateValidationOptions UnifiedAutomation.UaBase.DirectoryCertificateStore.ValidationOptions
getset

Gets or sets the validation options.

The validation options.


The documentation for this class was generated from the following file: