The KeyStore type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | KeyStore()()()() | Initializes a new Key Store object located in-memory. |
| KeyStore(String, String) | Initializes a new Key Store object. |
Methods
| Name | Description | |
|---|---|---|
| ChangePrivateKeyPassword(Int64, String, String) |
Changes private key password.
This method is equivalent to the GnuPG commands: gpg --edit-key [userId] Command>passwd |
| ChangePrivateKeyPassword(String, String, String) |
Changes private key password.
If more than one key pairs exist with the supplied userId, only the first one is affected. This method is equivalent to the GnuPG commands: gpg --edit-key [userId] Command>passwd |
| CheckPassword |
Checks if a password for a key store file is correct
|
| ContainsKey(Int64) |
Checks is there a key with the specified Key ID in this Key Store
|
| ContainsKey(String) |
Checks is there a key with the specified User Id in this Key Store
|
| ContainsPrivateKey(Int64) |
Checks is there a private key with the specified Key ID in this Key Store
|
| ContainsPrivateKey(String) |
Checks is there a private key with the specified User Id in this Key Store
|
| ContainsPublicKey(Int64) |
Checks is there a public key with the specified Key ID in this Key Store
|
| ContainsPublicKey(String) |
Checks is there a public key with the specified User Id in this Key Store
|
| DeleteKeyPair(Int64) |
Deletes the key pair (public and private key) from this key store that have the specified keyId.
|
| DeleteKeyPair(String) | Deletes the first key pair (public and private key) from this key store that has the specified userId. |
| DeletePrivateKey(Int64) |
Deletes a private key with the specified key Id from this KeyStore.
|
| DeletePrivateKey(String) | Deletes the first private key from this key store that has the specified User Id. |
| DeletePublicKey(Int64) |
Deletes the public key with the specified key Id from this key store.
|
| DeletePublicKey(String) | Deletes the first public key pair from this key store that has the specified User Id. |
| Equals | (Inherited from Object.) |
| ExportKeyRing(String, Int64) | Exports Key ring (both public and private key) located in this Key store in one file. |
| ExportKeyRing(String, String) | Exports a key ring (the public and private key combined) located in this key store in one file. |
| ExportKeyRing(String, Int64, Boolean) | Exports a key ring (the public and private key combined) located in this key store in one file. |
| ExportKeyRing(String, String, Boolean) | Exports a key ring (the public and private key combined) located in this key store in one file. |
| ExportPrivateKey(String, Int64, Boolean) | Exports private key from this OpenPGP key store into a file. |
| ExportPrivateKey(String, String, Boolean) | Exports private key from this OpenPGP key store into a file. |
| ExportPrivateKeyAsString(Int64) | Exports private key from this OpenPGP key store as a String in ASCII armored format. |
| ExportPrivateKeyAsString(String) | Exports private key from this OpenPGP key store as a String in ASCII armored format. |
| ExportPrivateKeyBytes(Int64) | Exports private key from this OpenPGP key store as a byte array. |
| ExportPrivateKeyBytes(String) | Exports private key from this OpenPGP key store as a byte array |
| ExportPrivateKeyStream(Int64) | Exports private key from this OpenPGP key store as an input stream for reading |
| ExportPrivateKeyStream(String) | Exports private key from this OpenPGP key store as an input stream for reading |
| ExportPublicKey(String, Int64, Boolean) | Exports public key from this OpenPGP key store into a file. |
| ExportPublicKey(String, String, Boolean) | Exports public key from this OpenPGP key store, into file. |
| ExportPublicKeyAsString(Int64) | Exports Public key from this OpenPGP key store as a String in ASCII armored format. |
| ExportPublicKeyAsString(String) | Exports Public key from this OpenPGP key store as a String in ASCII armored format. |
| ExportPublicKeyStream(Int64) | Exports public key from this OpenPGP key store as an input stream for reading |
| ExportPublicKeyStream(String) | Exports public key from this OpenPGP key store as an input stream for reading |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GenerateKeyPair(Int32, String, String) |
Generates OpenPGP Key pair with RSA encryption and predefined values for compression, hashing and cypher
like the ones generated with PGP Desktop(tm) wizard.
|
| GenerateKeyPair(Int32, String, KeyAlgorithm, String, array<CompressionAlgorithm>[]()[][], array<HashAlgorithm>[]()[][], array<CypherAlgorithm>[]()[][]) |
Generates OpenPGP Key pair (public and private key) with no expiration date.
The newly generated key is stored in this KeyStore instance. |
| GenerateKeyPair(Int32, String, String, String, String, String, String) |
Generates OpenPGP Key pair (public and private key).
The newly generated key is stored in this KeyStore instance. |
| GenerateKeyPair(Int32, String, KeyAlgorithm, String, array<CompressionAlgorithm>[]()[][], array<HashAlgorithm>[]()[][], array<CypherAlgorithm>[]()[][], DateTime) |
Generates PGP Key pair (public and private key) that expires on given date.
The newly generated key is stored in this KeyStore instance. |
| GenerateKeyPair(Int32, String, String, String, String, String, String, DateTime) |
Generates PGP Key pair (public and private key).
The newly generated key is stored in this KeyStore instance. |
| GenerateKeyPair(Int32, String, String, String, String, String, String, Int64) |
Generates PGP Key pair (public and private key).
The newly generated key is stored in this KeyStore instance. |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetKeyIdForKeyIdHex |
Returns the real Key ID (of type long) corresponding to this Hexadecimal Key Id.
|
| GetKeyIdForUserId |
Returns the real Key ID (of type long) corresponding to this User Id.
|
| GetKeys |
Returns the key pairs stored in this OpenPGP key store.
|
| GetPublicKeysData |
Returns the public keys data contained in this KeyStore |
| GetPublicKeysWithUserId |
Returns the public keys data with the specified User Id contained in this KeyStore |
| GetPublicKeyWithKeyId |
Returns the public key data with the specified Key Id contained in this IKeyStore |
| GetSecretKeysData |
Returns the secret keys data contained in this KeyStore |
| GetSecretKeysWithUserId |
Returns the secret keys data with the specified User Id contained in this IKeyStore |
| GetSecretKeyWithKeyId |
Returns the secret key data with the specified Key Id contained in this IKeyStore |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ImportKeyRing(FileInfo) |
Imports OpenPGP key ring in this key store.
|
| ImportKeyRing(String) |
Imports OpenPGP key ring in this KeyStore instance.
|
| ImportPrivateKey(String) |
Imports and OpenPGP private key into a custom OpenPGP key store.
|
| ImportPrivateKey(String, String) |
Imports and OpenPGP private key into a custom OpenPGP key store.
|
| ImportPublicKey |
Imports Public key into a custom OpenPGP key store. If the key store does not exist, it is created.
|
| isTrusted(Int64) |
Checks is a public key trusted in this Key store.
|
| isTrusted(String) |
Checks is a public key trusted in this Key store.
|
| LoadFromStream |
Loads the keystore data from a stream, where it has been stored previously
|
| loadKeyFile |
Helper method for importing external public or private keys
|
| LoadPublicKeysData |
Loads public keys data into this IKeyStore
from a byte array obtained from an OpenPGP public key ring
|
| LoadSecretKeysData |
Loads secret keys data into this IKeyStore
from a byte array obtained from an OpenPGP secret key ring
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
 | OpenFile | Initializes a new Key Store object. |
| OpenInMemory |
Creates a new in-memory KeyStore instance.
|
| Save | Saves the Key Store to disk. |
| SaveToStream |
Saves the keystore data to a stream
|
| SetTrust(Int64, TrustLevel) |
Sets an internal trust value for a public key, valid only in this KeyStore instance
|
| SetTrust(String, TrustLevel) |
Sets an internal trust value for a public key, valid only in this KeyStore instance
|
| SignPublicKey(Int64, Int64, String) |
Signs a public key with a specified private key.
|
| SignPublicKey(String, String, String) |
Signs a public key with a private key.
|
| SignPublicKeyAsTrustedIntroducer(Int64, Int64, String) |
Signs a public key as trusted introducer
|
| SignPublicKeyAsTrustedIntroducer(String, Int64, String) |
Signs a public key as trusted introducer
|
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
 | DSA |
Constant for DSA asymmetric algorithm
Used in DH/DSS key generation |
| ELGAMAL |
Constant for ElGamal asymmetric algorithm
Used in DH/DSS key generation |
 | keys |
List of keys contained in this KeyStore. Pairs of (keyId, KeyPairInformation)
|
| RSA |
Constant for RSA asymmetric algorithm
|
Properties
| Name | Description | |
|---|---|---|
 | AutoSave |
Property that indicates should the KeyStore backing file be auto saved
after each operation that changes its state.
|
| BackupOnSave |
Property that indicates should the old KeyStore backing file be
copied automatically in a file with extension .bak right before the save operation
|
| FileName |
File name where this KeyStore object is stored.
|
| HexKeyIds |
Returns array of Hexadecimal string representation of the key Id's for the keys contained in this KeyStore instance.
This hexadecimal value is composed of the lower four bytes of the real key Id (8 bytes) and is the same as the one displayed by PGP (r) and GnuPG. |
| IsInMemory |
Indicates is this KeyStore instance in-memory (True)
or file based (False)
|
| PartialMatchUserIds |
Sets/Gets is searching keys performed on whole User Id or only on part of it.
|
| Password |
Password of this KeyStore
|
| UserIds |
Returns array of Strings representing all user Id's contained in this KeyStore instance.
|
