Org.X509Crypto.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Org.X509Crypto</name> </assembly> <members> <member name="T:Org.X509Crypto.X509AliasNotFoundException"> <summary> Thrown when a presumed existing X509Alias is referenced from a specified X509Context, but the X509Alias is not found. </summary> </member> <member name="T:Org.X509Crypto.X509AliasAlreadyExistsException"> <summary> Thrown when an X509Alias is attempted to be committed, but it already exists in the target X509Context. </summary> </member> <member name="M:Org.X509Crypto.X509AliasAlreadyExistsException.#ctor(Org.X509Crypto.X509Alias)"> <summary> Instantiates an X509AliasAlreadyExistsException </summary> <param name="Alias">The X509Alias that already exists</param> </member> <member name="T:Org.X509Crypto.X509SecretAlreadyExistsException"> <summary> Thrown if an X509Secret is attempted to be added to an X509Alias, and the alias already contains a secret with the same name. </summary> </member> <member name="T:Org.X509Crypto.X509CryptoCertificateNotFoundException"> <summary> Thrown when there is no suitable encryption certificate found in the specified X509Context with the specified thumbprint value </summary> </member> <member name="M:Org.X509Crypto.X509CryptoCertificateNotFoundException.#ctor(System.String,Org.X509Crypto.X509Context)"> <summary> Instantiates an X509CryptoCertificateNotFoundException </summary> <param name="thumbprint">The thumbprint of the certificate which could not be located in the specified X509Context</param> <param name="Context">The X509Context which was checked for the encryption certificate</param> </member> <member name="T:Org.X509Crypto.X509ContextNotSupported"> <summary> Thrown when an unrecognized expression is passed to X509Context.Select() </summary> </member> <member name="T:Org.X509Crypto.X509AliasAttributeNotFoundException"> <summary> Thrown if a thumbprint or artifact name is not found in the specified X509Alias </summary> </member> <member name="T:Org.X509Crypto.X509DirectoryRightsException"> <summary> Thrown if the current thread does not have write permissions to the specified directory </summary> </member> <member name="T:Org.X509Crypto.X509CryptoException"> <summary> Thrown to indicate an otherwise unclassified exception </summary> </member> <member name="M:Org.X509Crypto.X509CryptoException.#ctor(System.String)"> <summary> Throws an exception with the indicated message </summary> <param name="message">The message to display in the exception</param> </member> <member name="M:Org.X509Crypto.X509CryptoException.#ctor(System.String,System.Exception)"> <summary> Throws an exception with the indicated message and includes an inner exception </summary> <param name="message">The message to display in the exception</param> <param name="innerException">The exception that actually occurred to prompt this exception</param> </member> <member name="T:Org.X509Crypto.Extensions"> <summary> Publicly-facing Extension Methods </summary> </member> <member name="M:Org.X509Crypto.Extensions.RemoveNonHexChars(System.String)"> <summary> Removes all non-hexidecimal characters from the specified string expression. Useful for removing artifact characters from a certificate thumbprint that was copied from the Certificates MMC snap-in </summary> <param name="expression">string expression</param> <returns>specified string expression with any non-hexidecimal ASCII characters (a-f,A-f,0-9) removed</returns> </member> <member name="M:Org.X509Crypto.Extensions.Matches(System.String,System.String,System.Boolean,System.Boolean)"> <summary> Extension method which indicates whether a string expression is the same as this string </summary> <param name="expression">this string</param> <param name="compareExpression">string expression to be compared with this string</param> <param name="caseSensitive">Indicates whether the compare should be case sensistive or not</param> <param name="ignoreWhitespace">Indicates whether surrounding whitespace should be ignored or not</param> <returns>true if the expressions match in accordance with the indicated options</returns> </member> <member name="M:Org.X509Crypto.Extensions.Contains(System.Collections.Generic.IEnumerable{System.String},System.String,System.Boolean)"> <summary> Extension method which indicates whether a string expression is found in a collection of strings </summary> <param name="Collection">this string collection</param> <param name="compareExpression">string expression to be compared with this string</param> <param name="caseSensitive">Indicates whether the compare should be case sensistive or not</param> <returns>true if any element in this collection matches the compare expression</returns> </member> <member name="M:Org.X509Crypto.Extensions.Matches(System.Security.SecureString,System.Security.SecureString)"> <summary> Determines whether two SecureString objects contain the same contents </summary> <param name="s1">A SecureString</param> <param name="s2">A SecureString to compare</param> <returns>True if the SecureString objects contain the same contents</returns> </member> <member name="M:Org.X509Crypto.Extensions.Plaintext(System.Security.SecureString)"> <summary> Converts a SecureString object to a normal string expression </summary> <param name="secret">The SecureString object to be converted</param> <returns>converted string expression</returns> </member> <member name="M:Org.X509Crypto.Extensions.InQuotes(System.String)"> <summary> Surrounds the specified expression with double-quotes </summary> <param name="expression">the expression to be surrounded with double-quotes</param> <returns></returns> </member> <member name="M:Org.X509Crypto.Extensions.IsSystemContext(Org.X509Crypto.X509Context)"> <summary> Returns true if this X509Context represents a local system context </summary> <param name="Context">an X509Context object</param> <returns>true if this X509Context represents a local system context</returns> </member> <member name="M:Org.X509Crypto.Extensions.IsUserContext(Org.X509Crypto.X509Context)"> <summary> Returns true if this X509Context represents a user context </summary> <param name="Context">an X509Context object</param> <returns>true if this X509Context represents a user context</returns> </member> <member name="T:Org.X509Crypto.X509Context"> <summary> Defines the CAPI store, file system location and name for an X509Cryto encryption context </summary> </member> <member name="M:Org.X509Crypto.X509Context.MakeCertWorker(System.String,System.Int32,System.Int32,System.String@)"> <summary> Generates a self-signed encryption certificate </summary> <param name="name">The certificate subject</param> <param name="keyLength">The desired public key length (multiples of 1024)</param> <param name="yearsValid">The number of years after which the certificate should be considered expired</param> <param name="thumbprint">reference string which will contain the thumbprint of the generated certificate</param> </member> <member name="P:Org.X509Crypto.X509Context.Location"> <summary> The CAPI store where an encryption certificate and key pair are contained </summary> </member> <member name="P:Org.X509Crypto.X509Context.Name"> <summary> The human-readable name of the context </summary> </member> <member name="P:Org.X509Crypto.X509Context.StorageDirectory"> <summary> The path where X509Alias files created in the context are stored. For "User" it is "C:\Users\\[sAMAccountName]\AppData\Local\X509Crypto" For "System" it is "C:\ProgramData\X509Crypto" </summary> </member> <member name="F:Org.X509Crypto.X509Context.UserReadOnly"> <summary> Provides read-only access to the context of the currently logged in (or impersonated) user. </summary> </member> <member name="F:Org.X509Crypto.X509Context.UserFull"> <summary> Provides read/write access to the context of the currently logged in (or impersonated) user. </summary> </member> <member name="F:Org.X509Crypto.X509Context.SystemReadOnly"> <summary> Provides read-only access to the context of the currently logged in (or impersonated) user. </summary> </member> <member name="F:Org.X509Crypto.X509Context.SystemFull"> <summary> Provides read/write access to the context of the currently logged in (or impersonated) user. </summary> </member> <member name="M:Org.X509Crypto.X509Context.Select(System.String,System.Boolean)"> <summary> Returns an X509Context object based on the indicated expression </summary> <param name="name">The name of the desired X509Context</param> <param name="writeable">Determines whether the X509Context should be writeable or not (this feature currently has no impact)</param> <returns>An X509Context object</returns> </member> <member name="M:Org.X509Crypto.X509Context.GetAliases(System.Boolean)"> <summary> Returns the collection of all <see cref="T:Org.X509Crypto.X509Alias"/>es found in this context </summary> <returns>the collection of all <see cref="T:Org.X509Crypto.X509Alias"/>es found in this context</returns> </member> <member name="M:Org.X509Crypto.X509Context.CreateImpersonatedUserAppDirectory(System.String)"> <summary> Creates the directory for an impersonated user where X509Alias files will be stored for later retrieval </summary> <param name="sAMAccountName">The username of the impersonated user</param> </member> <member name="T:Org.X509Crypto.SecretDumpFormat"> <summary> Specifies a format in which to output the decrypted secrets from a <see cref="T:Org.X509Crypto.X509Alias"/> </summary> </member> <member name="T:Org.X509Crypto.X509Alias"> <summary> Represents an X509Context, a certificate/key pair and 0 or more secrets encrypted by the certificate/key pair </summary> </member> <member name="P:Org.X509Crypto.X509Alias.Name"> <summary> The identifier assigned to this alias </summary> </member> <member name="P:Org.X509Crypto.X509Alias.Thumbprint"> <summary> The thumbprint of the certificate used for cryptographic operations in this alias </summary> </member> <member name="P:Org.X509Crypto.X509Alias.Context"> <summary> The context where cryptographic operations shoudl occur (either system or user) </summary> </member> <member name="P:Org.X509Crypto.X509Alias.FullName"> <summary> The fully-qualified name of the X509Alias in the format [Context]\[Name] </summary> </member> <member name="M:Org.X509Crypto.X509Alias.#ctor(System.String,Org.X509Crypto.X509Context)"> <summary> This constructor is intended to load an already-existing X509Alias </summary> <param name="Name">The desired identifier for the alias (must be unique within the specified context</param> <param name="Context">The context in which to create the alias</param> </member> <member name="M:Org.X509Crypto.X509Alias.#ctor(System.String,System.String,Org.X509Crypto.X509Context,System.Boolean)"> <summary> This constructor is intended to create a new X509Alias pointing to the specified encryption certificate </summary> <param name="Name">The desired identifier for the alias</param> <param name="Thumbprint">The SHA1 thumbprint of the certificate to be used for cryptographic operations. Must exist in the specified Context</param> <param name="Context">The context in which to create the alias</param> <param name="complainIfExists">If set to true, an exception is thrown if an existing alias identifier is specified for "Name"</param> </member> <member name="M:Org.X509Crypto.X509Alias.Dispose"> <summary> X509Alias Destructor </summary> </member> <member name="M:Org.X509Crypto.X509Alias.EncryptText(System.String)"> <summary> Encrypts the specified text expression </summary> <param name="plaintext">the text expression to be encrypted</param> <returns>Base64-encoded ciphertext string</returns> </member> <member name="M:Org.X509Crypto.X509Alias.EncryptFile(System.String,System.String,System.Int32)"> <summary> Encrypts the specified file. All file types are supported. </summary> <param name="inFile">The path to the file to be encrypted. Path must exist.</param> <param name="outFile">he path in which to write the encrypted file.</param> <param name="wipeTimesToWrite">Performs n-pass forensic wipe of the disk sectors where the input file was stored.</param> </member> <member name="M:Org.X509Crypto.X509Alias.ReEncryptFile(System.String,Org.X509Crypto.X509Alias)"> <summary> Re-encrypts the specified file using this X509Alias </summary> <param name="inFile">The path to the ciphertext file to re-encrypt</param> <param name="OldAlias">The X509Alias which was previously used to encrypt the file</param> </member> <member name="M:Org.X509Crypto.X509Alias.DecryptFile(System.String,System.String,System.Int32)"> <summary> Recovers the specified encrypted file </summary> <param name="inFile">The path to the encrypted file to be recovered. Path must exist</param> <param name="outFile">The path in which to write the recovered plaintext file</param> <param name="wipeTimesToWrite">Performs n-pass forensic wipe of the disk sectors where the input file was stored.</param> </member> <member name="M:Org.X509Crypto.X509Alias.ReEncryptText(System.String,Org.X509Crypto.X509Alias)"> <summary> Re-Encrypts a ciphertext expression, currently encrypted in a different X509Alias, using this X509Alias </summary> <param name="ciphertext">The ciphertext expression to be reencrypted</param> <param name="OldAlias">The identifier of the X509Alias where the input secret is located</param> <returns>A Bas64-encoded ciphertext string</returns> </member> <member name="M:Org.X509Crypto.X509Alias.ReEncryptSecret(System.String,Org.X509Crypto.X509Alias)"> <summary> Re-Encrypts a secret that is stored in a different X509Alias </summary> <param name="secretName">The identifier of the secret to be re-encrypted</param> <param name="OldAlias">The X509Alias where the secret is stored</param> <returns>A Base64-encoded ciphtertext string</returns> </member> <member name="M:Org.X509Crypto.X509Alias.DecryptText(System.String)"> <summary> Decrypts the specified Base64-encoded ciphertext expression </summary> <param name="ciphertext">The Base64-encoded ciphertext expression to be decrypted</param> <returns>A recovered plaintext string</returns> </member> <member name="M:Org.X509Crypto.X509Alias.AddSecret(System.String,System.String,System.Boolean)"> <summary> Encrypts the specified plaintext expression and stores it in this X509Alias </summary> <param name="key">The desired identifier for the secret (must be unique within the alias)</param> <param name="plaintext">The plaintext expression to be encrypted</param> <param name="overwriteExisting">Indicates whether an existing secret in the alias with the same value for "Name" as specified may be overwritten</param> <returns>A Base64-encoded ciphertext string</returns> </member> <member name="M:Org.X509Crypto.X509Alias.AddSecret(System.Collections.Generic.KeyValuePair{System.String,System.String},System.Boolean)"> <summary> Adds a secret (which has already been encrypted using the certificate associated with this X509Alias) and its identifier to this X509Alias </summary> <param name="tuple">Key should be the secret identifier, Value should be the encrypted secret</param> <param name="overwriteExisting">Indicates whether an existing secret in the alias with the same value for "Name" as specified may be overwritten</param> </member> <member name="M:Org.X509Crypto.X509Alias.AddSecret(System.String,Org.X509Crypto.X509Alias,System.Boolean)"> <summary> Re-encrypts a secret from a different X509Alias and stores it in this X509Alias </summary> <param name="key">The identifier of the secret as it is stored in the old X509Alias</param> <param name="OldAlias">The old X509Alias where the secret is currently encrypted and stored</param> <param name="overwriteExisting">If true, an existing secret in this X509Alias with the same identifier may be overwritten</param> <returns>A Base64-encoded ciphertext expression</returns> </member> <member name="M:Org.X509Crypto.X509Alias.GetSecret(System.String)"> <summary> Gets the ciphertext value for the specified secret from the current X509Alias </summary> <param name="key">The identifier of the secret</param> <returns>A Base64-encoded ciphertext expression</returns> </member> <member name="M:Org.X509Crypto.X509Alias.SecretExists(System.String)"> <summary> Indicates whether a secret with the specified identifier exists within this X509Alias </summary> <param name="key">The secret identifier to check the X509Alias for</param> <returns>true if a secret with the specified identifier is found in this X509Alias</returns> </member> <member name="M:Org.X509Crypto.X509Alias.RecoverSecret(System.String)"> <summary> Recovers a secret from an X509Alias with the specified identifier </summary> <param name="key">The identifier of the secret to be recovered</param> <returns>The recovered, plaintext secret</returns> </member> <member name="M:Org.X509Crypto.X509Alias.ReEncrypt(System.String,Org.X509Crypto.X509Context)"> <summary> Updates this X509Alias to use a new encryption certificate and key pair. The old certificate and key pair must still be available to perform this operation. </summary> <param name="newThumbprint">The SHA1 thumbprint of the new encryption certificate. The certificate and associated key pair must exist and be available in the specified X509Context</param> <param name="newContext">The X509Context where the new encryption certificate and key pair is located</param> </member> <member name="M:Org.X509Crypto.X509Alias.ExportCert(System.String)"> <summary> Exports the encryption certificate contained in this alias to a Base64-encoded text file. The private key is not exported. </summary> <param name="path">The fully-qualified path where the export file should be written</param> </member> <member name="M:Org.X509Crypto.X509Alias.Export(System.String@,System.Boolean,System.Boolean)"> <summary> Exports this X509Alias to a Json-formatted file Note: This method does NOT export the encryption certificate or the associated key pair. </summary> <param name="exportPath">The path where the export file should be written (a .json extension is added if no file extension is specified)</param> <param name="overwriteExisting">Indicates whether an existing file may be overwritten if a file should exist at the indicated export path</param> </member> <member name="M:Org.X509Crypto.X509Alias.Commit"> <summary> Writes the X509Alias to the local file system for later retrieval </summary> </member> <member name="M:Org.X509Crypto.X509Alias.Remove(System.Boolean)"> <summary> Removes this X509Alias from the file system </summary> </member> <member name="M:Org.X509Crypto.X509Alias.DumpSecrets(Org.X509Crypto.SecretDumpFormat,System.Boolean)"> <summary> Generates a data structure, in the selected format of all secret names and values contained within the <see cref="T:Org.X509Crypto.X509Alias"/> </summary> <param name="selectedFormat">The desired fromat in which to return the data</param> <param name="reveal">indicates whether the encrypted value for each secret should be decrypted and included with the output.</param> </member> <member name="M:Org.X509Crypto.X509Alias.DumpSecretsText(System.Boolean)"> <summary> Generates a text report of the X509Artifacts contained within this X509Alias </summary> <param name="reveal">Indicates whether the plaintext values of each X509Secret should be revealed in the output</param> <returns>A text report listing all X509Secrets contained within this X509Alias</returns> </member> <member name="M:Org.X509Crypto.X509Alias.DumpSecretsCSV(System.Boolean)"> <summary> Generates a comma-separated report of the X509Secrets contained within this X509Alias </summary> <param name="reveal">Indicates whether the plaintext values of each X509Secret should be revealed in the output</param> <returns>A comma-separated report listing all X509Secrets contained within this X509Alias</returns> </member> <member name="M:Org.X509Crypto.X509Alias.Exists"> <summary> Indicates whether the X509Alias already exists on the local system (meaning committed to storage) </summary> <returns>True if the X509Alias already exists on the local system</returns> </member> <member name="M:Org.X509Crypto.X509Alias.Import(System.String,Org.X509Crypto.X509Context,System.String)"> <summary> Imports the X509Alias from the specified Json file Note: This method does not import the encryption certificate or its associated key pair needed to work with the X509Alias. </summary> <param name="importPath">The path where the json file is located</param> <param name="Context">The X509Context in which to load the alias</param> <param name="newName">If specified, the alias will be identified by the specified expression. Otherwise, the alias name imported from the json file will be used.</param> <returns></returns> </member> <member name="M:Org.X509Crypto.X509Alias.AliasExists(Org.X509Crypto.X509Alias)"> <summary> Indicates whether there is already a storage path for the specified X509Alias on the system </summary> <param name="Alias">The X509Alias for which to check for a storage path</param> <returns>true if a storage path exists for the specified X509Alias</returns> </member> <member name="T:Org.X509Crypto.X509CryptoAgent"> <summary> Instantiatable class which can be used to perform cryptographic operations on string expressions and files. </summary> <remarks> It is advisable to leverage an instance of this class in your method/module if you need to perform several cryptographic operations within the stack frame. </remarks> </member> <member name="P:Org.X509Crypto.X509CryptoAgent.Thumbprint"> <summary> The thumbprint of the certificate used for cryptographic operations </summary> </member> <member name="P:Org.X509Crypto.X509CryptoAgent.Context"> <summary> The certificate store from which to load the encryption certificate and private key. </summary> <remarks> Possible values are <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/> or <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="!:CertStore.LocalMachine"/><br/> If not specified, default value is <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/> </remarks> </member> <member name="F:Org.X509Crypto.X509CryptoAgent.valid"> <summary> Indicates whether the instantiated <see cref="T:Org.X509Crypto.X509CryptoAgent"/> object is bound to an available valid certificate and corresponding private key that is appropriate for encryption </summary> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.#ctor(System.String,Org.X509Crypto.X509Context)"> <summary> X509CryptoAgent Constructor </summary> <param name="thumbprint">The thumbprint of the encryption certificate. The certificate must be present in the CURRENTUSER store location</param> <param name="context">The X509Context where the encryption certificate can be accessed</param> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.Dispose"> <summary> X509CryptoAgent Destructor </summary> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.EncryptText(System.String)"> <summary> Encrypts the specified string expression </summary> <param name="plainText">Text expression to encrypt</param> <returns>Base64-encoded ciphertext expression</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string plaintext = @"Hello world!"; string ciphertext; using (<see cref="T:Org.X509Crypto.X509CryptoAgent"/> agent = new <see cref="T:Org.X509Crypto.X509CryptoAgent"/>(thumbprint, certStore)) { ciphertext = agent.EncryptText(plaintext); } </code> </example> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.ReEncryptText(System.String,Org.X509Crypto.X509CryptoAgent)"> <summary> Re-encrypts the specified ciphertext expression using a different X509CryptoAgent </summary> <param name="ciphertext">the ciphertext expression to be re-encrypted</param> <param name="newAgent">the X509CryptoAgent to be used to perform re-encryption</param> <returns></returns> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.EncryptFile(System.String,System.String)"> <summary> Encrypts the specified plaintext file. Text and binary file types are supported. </summary> <param name="plainText">Fully-qualified path of the file to be encrypted</param> <param name="cipherText">Fully-qualified path in which to write the encrypted file</param> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string plaintextFilePath = @"C:\data\SSNs.txt"; string ciphertextFilePath = Path.GetFileNameWithoutExtension(plaintextFilePath)" + <see cref="F:Org.X509Crypto.X509Utils.CRYPTO_ENCRYPTED_FILE_EXT"/>; using (<see cref="T:Org.X509Crypto.X509CryptoAgent"/> agent = new <see cref="T:Org.X509Crypto.X509CryptoAgent"/>(thumbprint, certStore)) { agent.EncryptFile(plaintextFilePath, ciphertextFilePath); } </code> </example> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.EncryptFileFromByteArray(System.Byte[],System.String)"> <summary> Encrypts an array of bytes and stores the encrypted playload in the specified file path </summary> <remarks> This method is implemented primarily to fascilitate re-encryption of a file when changing certificates </remarks> <param name="memBytes">The byte array to encrypt</param> <param name="cipherText">The file path in which to store the encrypted payload</param> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; byte[] fileBytes = File.ReadAllBytes(@"C:\data\example.txt"); string ciphertextFilePath = @"C:\data\example_encrypted.ctx"; using (<see cref="T:Org.X509Crypto.X509CryptoAgent"/> agent = new <see cref="T:Org.X509Crypto.X509CryptoAgent"/>(thumbprint, certStore)) { agent.EncryptFileFromByteArray(fileBytes, ciphertextFilePath); } </code> </example> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.DecryptText(System.String)"> <summary> Decrypts the specified ciphertext expression </summary> <param name="cipherText">Base64-encoded ciphertext expression</param> <returns>decrypted string expression</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string ciphertext = File.ReadAllText(@"C:\data\connectionString.txt"); string plaintext; using (<see cref="T:Org.X509Crypto.X509CryptoAgent"/> agent = new <see cref="T:Org.X509Crypto.X509CryptoAgent"/>(thumbprint, certStore)) { plaintext = agent.DecryptText(ciphertext); } </code> </example> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.DecryptFile(System.String,System.String)"> <summary> Decrypts the specified ciphertext file </summary> <param name="cipherText">Fully-qualified path to the encrypted file</param> <param name="plainText">Fully-qualified path in which to write the decrypted file</param> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string ciphertextFilePath = @"C:\data\SSNs.txt.ctx"; string plaintextFilePath = @"C:\data\SSNs.txt"; using (<see cref="T:Org.X509Crypto.X509CryptoAgent"/> agent = new <see cref="T:Org.X509Crypto.X509CryptoAgent"/>(thumbprint, certStore)) { plaintext = agent.DecryptFile(ciphertextFilePath, plaintextFilePath); } </code> </example> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.DecryptFileToByteArray(System.String)"> <summary> Decrypts a file and stores the payload in a byte array </summary> <remarks> This method is implemented primarily to fascilitate re-encryption of a file when changing certificates </remarks> <param name="cipherText">The fully-qualified path to the encrypted file</param> <returns>Byte array containing the decrypted contents of the ciphertext file</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string ciphertextFilePath = @"C:\data\SSNs.txt.ctx"; byte[] plaintextBytes; using (<see cref="T:Org.X509Crypto.X509CryptoAgent"/> agent = new <see cref="T:Org.X509Crypto.X509CryptoAgent"/>(thumbprint, certStore)) { plaintextBytes = agent.DecryptFileToByteArray(ciphertextFilePath); } </code> </example> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.DecryptTextFromFile(System.String)"> <summary> Decrypts a ciphertext expression that is stored in a text file </summary> <param name="path">The fully-qualified path to the file containing the ciphertext expression</param> <returns>decrypted text expression</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string ciphertextFilePath = @"C:\data\connectionString.txt"; string plaintext; using (<see cref="T:Org.X509Crypto.X509CryptoAgent"/> agent = new <see cref="T:Org.X509Crypto.X509CryptoAgent"/>(thumbprint, certStore)) { plaintext = agent.DecryptTextFromFile(ciphertextFilePath); } </code> </example> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.CertificateExists(System.String,Org.X509Crypto.X509Context)"> <summary> Indicates whether the certificate with the specified thumbprint was found in the specified certificate store </summary> <param name="certThumbprint">The certificate thumbprint value to search for (case-insensitive)</param> <param name="Context">The certificate store from which to load the encryption certificate. Either CertStore.CurrentUser (default) or CertStore.LocalMachine</param> <returns>True or False depending upon whether the certificate and corresponding private key was found in the certificate store</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; bool found; using (<see cref="T:Org.X509Crypto.X509CryptoAgent"/> agent = new <see cref="T:Org.X509Crypto.X509CryptoAgent"/>(thumbprint, certStore)) { found = agent.CertificateExists(thumbprint, certStore); } </code> </example> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.CertificateExists(Org.X509Crypto.X509Alias)"> <summary> Indicates whether the encryption certificate referenced by the specified X509Alias exists in the alias context. </summary> <param name="Alias">The X509Alias to check for encryption certificate existence</param> <returns>true if the encryption certificate referenced in the X509Alias exists in the alias context</returns> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.ExportCert(System.String,Org.X509Crypto.X509Context,System.String)"> <summary> Exports the public certificate corresponding to the specified certificate thumbprint to a Base64-encoded file </summary> <param name="thumbprint">Thumbprint of the certificate to be exported</param> <param name="Context">The X509Context where the certificate to be exported exists</param> <param name="path">The storage path to where the file containing the public certificate should be written</param> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.ListCerts(Org.X509Crypto.X509Context,System.Boolean)"> <summary> Lists the thumbprint value for all encryption certificates which exist in the specified store location. Certificates which do not have the "Key Encipherment" key usage flag set are not included in the list. </summary> <param name="Context">The X509Context from which to list certificates</param> <param name="includeExpired">If true, expired certificates will be included in the resulting list</param> <returns>Line-break-separated list of certificate details</returns> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.ListAliases(Org.X509Crypto.X509Context)"> <summary> Lists all aliases that are found in the specified X509Context </summary> <param name="Context">The X509Context from which to list existing aliases</param> <returns>Line-break-separated list of X509Alias details</returns> </member> <member name="M:Org.X509Crypto.X509CryptoAgent.ExportPFX(System.String,Org.X509Crypto.X509Context,System.String,System.String)"> <summary> Exports the encryption certificate and corresponding key pair to a file in PKCS#12 format </summary> <param name="thumbprint">The thumbprint of the encryption certificate</param> <param name="Context">The X509Context where the certificate and corresponding key pair exist</param> <param name="pfxPath">The path to where the PKCS#12 file should be written</param> <param name="password">The password which will protect the PKCS#12 file</param> </member> <member name="T:Org.X509Crypto.X509Utils"> <summary> A static class which provides access to X509Crypto namespace functionality without instantiating a X509CryptoAgent object. </summary> </member> <member name="F:Org.X509Crypto.X509Utils.INVOKER_IS_ADMINISTRATOR"> <summary> Indicates whether the invoking user is a local administrator on the system </summary> </member> <member name="F:Org.X509Crypto.X509Utils.CRYPTO_ENCRYPTED_FILE_EXT"> <summary> Default file extension for files encrypted with the X509Crypto library </summary> </member> <member name="F:Org.X509Crypto.X509Utils.CRYPTO_DECRYPTED_FILE_EXT"> <summary> Default file extension for files decrypted using the X509Crypto library (only used if the appropriate file extension cannot be inferred from the ciphertext file path </summary> </member> <member name="M:Org.X509Crypto.X509Utils.LoadTextFromFile(System.String)"> <summary> Loads the contents of a text file into a string expression </summary> <param name="path">The fully-qualified path to the file from which contents are being loaded</param> <returns>The contents of the specified text file as a string expression</returns> </member> <member name="M:Org.X509Crypto.X509Utils.FormatThumbprint(System.String,System.Boolean)"> <summary> Removes all but hexidecimal characters (0-9, a-f) from the indicated text expression </summary> <param name="thumbprint">string containing a thumbprint value</param> <param name="verbose">True enables verbose logging</param> <returns>Text expression with all non hexidecimal characters removed</returns> <example> <code> string thumb = @"cc dc 67 3c 40 eb b2 a4 33 30 0c 0c 8a 2b a6 f4 43 da 56 88"; string formattedThumb = X509Utils.FormatThumbprint(thumb); //formattedThumb = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688" </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.DecryptText(System.String,System.String,Org.X509Crypto.X509Context,System.Boolean)"> <summary> Decrypts the specified ciphertext expression </summary> <param name="thumbprint">The thumbprint of the certificate corresponding to the public key used to encrypt the file</param> <param name="ciphertext">The ciphertext expression to decrypt</param> <param name="Context">The certificate store location where the specified private key resides</param> <param name="verbose">True enables verbose logging</param> <returns>Plaintext string expression resulting from decryption of the specified ciphertext expression</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> Context = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string ciphertext = File.ReadAllText(@"C:\data\connectionString.txt"); string plaintext = <see cref="T:Org.X509Crypto.X509Utils"/>.DecryptText(thumbprint, ciphertext, Context); </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.DecryptFile(System.String,System.String,System.String,Org.X509Crypto.X509Context,System.Boolean)"> <summary> Decrypts the specified encrypted file </summary> <param name="thumbprint">The thumbprint of the certificate corresponding to the public key used to encrypt the file</param> <param name="ciphertextFilePath">The fully-qualified path of the encrypted file</param> <param name="plaintextFilePath">The fully-qualified path in which to write the decrypted file</param> <param name="Context">The certificate store where the encryption certificate resides</param> <param name="verbose">True enables verbose logging</param> <returns>True or false depending upon whether the file decryption succeeded</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string encryptedFilePath = @"C:\Data\accounts.csv.ctx"; bool success = <see cref="T:Org.X509Crypto.X509Utils"/>.DecryptFile(thumbprint, encryptedFilePath, certStore); </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.EncryptText(System.String,System.String,Org.X509Crypto.X509Context,System.Boolean)"> <summary> Encrypts the specified plaintext expression </summary> <param name="thumbprint">The thumbprint of the certificate to use for encryption</param> <param name="plaintext">The plaintext expression to encrypt</param> <param name="Context">The certificate store where the encryption certificate resides</param> <param name="verbose">True enables verbose logging</param> <returns></returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string plaintext = @"Please encrypt this"; string ciphertext = <see cref="T:Org.X509Crypto.X509Utils"/>.EncryptText(thumbprint, plaintext, certStore); </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.EncryptFile(System.String,System.String,Org.X509Crypto.X509Context,System.String,System.Boolean)"> <summary> Encrypts the specified file </summary> <param name="thumbprint">The thumbprint of the certificate to use for encryption</param> <param name="plaintextFilePath">The fully-qualified path of the plaintext file (can be text or binary)</param> <param name="Context">(Optional) The certificate store where the encryption certificate resides (Default: <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>)</param> <param name="ciphertextFilePath">(Optional) The fully-qualified path in which to write the encrypted file (If not specified, the plaintext file path is appended with a ".ctx" extension)</param> <param name="verbose">(Optional) True enables verbose logging</param> <returns></returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/> string plaintextFilePath = @"C:\Data\accounts.csv"; string ciphertextFilePath = bool success = <see cref="T:Org.X509Crypto.X509Utils"/>.EncryptFile(thumbprint, plaintextFilePath, certStore); </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.ReEncryptText(System.String,System.String,System.String,Org.X509Crypto.X509Context,Org.X509Crypto.X509Context,System.Boolean)"> <summary> Re-encrypts a ciphertext expression using a different certificate </summary> <param name="oldThumbprint">The thumbprint of the old certificate used for prior encryption</param> <param name="newThumbprint">The thumbprint of the new certificate to be used for re-encryption</param> <param name="ciphertext">The ciphertext expression to be re-encrypted</param> <param name="OldContext">(Optional) The X509Context where the old encryption certificate resides (Default: <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>)</param> <param name="NewContext">(Optional) The X509Context where the new encryption certificate resides (Default: <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>)</param> <param name="verbose">(Optional) True enables verbose logging (Default: false)</param> <returns>The text expression re-encrypted using the new certificate</returns> <example> <code> string oldThumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; string newThumbprint = @"0e7e327aab74e47a702c02d90c659da1115b29f7"; string ciphertext = File.ReadAllText(@"C:\data\connectionString.txt"); string updatedCiphertext = <see cref="T:Org.X509Crypto.X509Utils"/>.ReEncryptText(oldThumbprint, newThumbprint, ciphertext); File.WriteAllText(@"C:\data\connectionString.txt", updatedCiphertext); </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.ReEncryptFile(System.String,System.String,System.String,Org.X509Crypto.X509Context,Org.X509Crypto.X509Context,System.Boolean)"> <summary> Re-encrypts an encrypted file using a different encryption certificate </summary> <param name="oldThumbprint">The thumbprint of the old certificate used for prior encryption</param> <param name="newThumbprint">The thumbprint of the new certificate to be used for re-encryption</param> <param name="ciphertextFilePath">The fully-qualified path to the ciphertext file to be re-encrypted</param> <param name="OldContext">(Optional) The certificate store where the old encryption certificate resides (Default: <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>)</param> <param name="NewContext">(Optional) The certificate store where the new encryption certificate resides (Default: <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>)</param> <param name="verbose">(Optional) True enables verbose logging (Default: false)</param> <example> <code> string oldThumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; string newThumbprint = @"0e7e327aab74e47a702c02d90c659da1115b29f7"; string encryptedFilePath = @"C:\data\accounts.csv.ctx"; <see cref="T:Org.X509Crypto.X509Utils"/>.ReEncryptFile"(oldThumbprint, newThumbprint, encryptedFilePath); </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.ReEncryptFile(Org.X509Crypto.X509Alias,Org.X509Crypto.X509Alias,System.String)"> <summary> Re-encrypts an encrypted file using a different </summary> <param name="OldAlias">The old X509Alias that was originally used to encrypt the file</param> <param name="NewAlias">The new X509Alias that will be used to re-encrypt the file</param> <param name="ciphertextFilePath">The path to the ciphertext file to be re-encrypted</param> </member> <member name="M:Org.X509Crypto.X509Utils.InstallCert(System.String,System.Security.SecureString,Org.X509Crypto.X509Context)"> <summary> Installs an encryption certificate and associated key pair in the specified X509Context </summary> <param name="infile">The PKCS#12 (usually with a .pfx or .p12 extension) containing the bundled certificate and key pair</param> <param name="PfxPassword">The password to unlock the PKCS#12 file</param> <param name="Context">The X509Context in which to place the certificate and key pair</param> <returns></returns> </member> <member name="M:Org.X509Crypto.X509Utils.ExportPFX(System.String,System.String,System.String,Org.X509Crypto.X509Context,System.Boolean)"> <summary> Exports the certificate and public/private key pair corresponding to the specified certificate thumbprint to a PKCS#12 bundle written to the specified file path </summary> <param name="certThumbprint">Certificate thumbprint (case-insensitive)</param> <param name="exportPath">Fully-qualified path to where the PKCS#12 bundle file should be written (a ".pfx" file extension will be added if no file extension is detected)</param> <param name="password">Password to protect the private key once stored in the PKCS#12 bundle file</param> <param name="Context">(Optional) The certificate store where the encryption certificate resides (Default: <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>)</param> <param name="verbose">(Optional) True enables verbose logging (Default: false)</param> <returns>The fully-qualified path to where the PKCS#12 bundle file was ultimately written</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; string exportPath = @"C:\data\bundle"; string password = @"0n3T!m3U$e"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string finalExportPath = <see cref="T:Org.X509Crypto.X509Utils"/>.ExportPFX(thumbprint, exportPath, password, certStore); //finalExportPath is @"C:\data\bundle.pfx" </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.ExportCert(System.String,System.String,Org.X509Crypto.X509Context,System.Boolean)"> <summary> Exports the certificate corresponding to the specified certificate thumbprint to a Base64-encoded text file </summary> <param name="certThumbprint">Certificate thumbprint (case-insensitive)</param> <param name="exportPath">Fully-qualified path to where the Base64-encoded file should be written (a ".cer" file extension will be added if no file extension is detected)</param> <param name="Context">(Optional) The certificate store where the encryption certificate resides (Default: <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>)</param> <param name="verbose">True enables verbose logging</param> <returns>The fully-qualified path to where the Base64-encoded certificate file was ultimately written</returns> <example> <code> string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688"; string exportPath = @"C:\data\cert"; <see cref="T:Org.X509Crypto.X509Context"/> certStore = <see cref="T:Org.X509Crypto.X509Context"/>.<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>; string finalExportPath = <see cref="T:Org.X509Crypto.X509Utils"/>.ExportCert(thumbprint, exportPath, certStore); //finalExportPath is @"C:\data\cert.cer" </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.WipeFile(System.String,System.Int32)"> <summary> Overwrites a file (as stored on disk) with random bits in order to prevent forensic recovery of the data </summary> <param name="filePath">The fully-qualified path of the file to wipe from disk</param> <param name="timesToWrite">The number of times to overwrite the disk sectors where the file is/was stored</param> <example> <code> string path = @"C:\temp\SSNs.txt"; int timesToWrite = 10; <see cref="T:Org.X509Crypto.X509Utils"/>.<see cref="M:Org.X509Crypto.X509Utils.WipeFile(System.String,System.Int32)"/>(path, timesToWrite); </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.ListCerts(Org.X509Crypto.X509Context,System.Boolean)"> <summary> Lists the thumbprint value for each certificate in the specified store location which include "Key Encipherment" in its Key Usage extension </summary> <param name="Context">Store location from which to list certificate details (Either <see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/> or <see cref="F:Org.X509Crypto.X509Context.SystemReadOnly"/>)</param> <param name="allowExpired">If set to True, expired certificates will be included in the output (Note that .NET will not perform cryptographic operations using a certificate which is not within its validity period)</param> <returns>A string expression listing all available certificate thumbprints and their expiration dates</returns> <example> <code> string availableCerts = <see cref="T:Org.X509Crypto.X509Utils"/>.<see cref="M:Org.X509Crypto.X509Utils.ListCerts(Org.X509Crypto.X509Context,System.Boolean)"/>(<see cref="F:Org.X509Crypto.X509Context.UserReadOnly"/>); </code> </example> </member> <member name="M:Org.X509Crypto.X509Utils.DeleteFile(System.String,System.Boolean,System.Boolean)"> <summary> Deletes the specified file </summary> <param name="filePath">The path of the file to be deleted</param> <param name="complainIfNotFound">If true, an exception is thrown if the file does not currently exist</param> <param name="confirmDelete">If true, the file will be confirmed to no longer exist. If it still exists, an exception is thrown</param> </member> <member name="M:Org.X509Crypto.X509Utils.MethodName"> <summary> Gets the name of the calling method </summary> <returns>The name of the calling method</returns> </member> </members> </doc> |