diff options
Diffstat (limited to 'crypto/src/crmf/EncryptedValueBuilder.cs')
-rw-r--r-- | crypto/src/crmf/EncryptedValueBuilder.cs | 71 |
1 files changed, 35 insertions, 36 deletions
diff --git a/crypto/src/crmf/EncryptedValueBuilder.cs b/crypto/src/crmf/EncryptedValueBuilder.cs index f9279bd53..28d5b52b4 100644 --- a/crypto/src/crmf/EncryptedValueBuilder.cs +++ b/crypto/src/crmf/EncryptedValueBuilder.cs @@ -24,23 +24,23 @@ namespace Org.BouncyCastle.Crmf private ICipherBuilderWithKey encryptor; private EncryptedValuePadder padder; - /** - * Create a builder that makes EncryptedValue structures. - * - * @param wrapper a wrapper for key used to encrypt the actual data contained in the EncryptedValue. - * @param encryptor an output encryptor to encrypt the actual data contained in the EncryptedValue. - */ + /// + /// Create a builder that makes EncryptedValue structures. + /// + /// <param name="wrapper">wrapper a wrapper for key used to encrypt the actual data contained in the EncryptedValue.</param> + /// <param name="encryptor">encryptor an output encryptor to encrypt the actual data contained in the EncryptedValue. </param> + /// public EncryptedValueBuilder(IKeyWrapper wrapper, ICipherBuilderWithKey encryptor) : this(wrapper, encryptor, null) { } - /** - * Create a builder that makes EncryptedValue structures with fixed length blocks padded using the passed in padder. - * - * @param wrapper a wrapper for key used to encrypt the actual data contained in the EncryptedValue. - * @param encryptor an output encryptor to encrypt the actual data contained in the EncryptedValue. - * @param padder a padder to ensure that the EncryptedValue created will always be a constant length. - */ + /// + /// Create a builder that makes EncryptedValue structures with fixed length blocks padded using the passed in padder. + /// + /// <param name="wrapper">a wrapper for key used to encrypt the actual data contained in the EncryptedValue.</param> + /// <param name="encryptor">encryptor an output encryptor to encrypt the actual data contained in the EncryptedValue.</param> + /// <param name="padder">padder a padder to ensure that the EncryptedValue created will always be a constant length.</param> + /// public EncryptedValueBuilder(IKeyWrapper wrapper, ICipherBuilderWithKey encryptor, EncryptedValuePadder padder) { this.wrapper = wrapper; @@ -48,26 +48,25 @@ namespace Org.BouncyCastle.Crmf this.padder = padder; } - /** - * Build an EncryptedValue structure containing the passed in pass phrase. - * - * @param revocationPassphrase a revocation pass phrase. - * @return an EncryptedValue containing the encrypted pass phrase. - * @throws CrmfException on a failure to encrypt the data, or wrap the symmetric key for this value. - */ + /// + /// Build an EncryptedValue structure containing the passed in pass phrase. + /// + /// <param name="revocationPassphrase">a revocation pass phrase.</param> + ///<returns>an EncryptedValue containing the encrypted pass phrase.</returns> + /// public EncryptedValue Build(char[] revocationPassphrase) { return encryptData(padData(Strings.ToUtf8ByteArray(revocationPassphrase))); } - /** - * Build an EncryptedValue structure containing the certificate contained in - * the passed in holder. - * - * @param holder a holder containing a certificate. - * @return an EncryptedValue containing the encrypted certificate. - * @throws CrmfException on a failure to encrypt the data, or wrap the symmetric key for this value. - */ + ///<summary> + /// Build an EncryptedValue structure containing the certificate contained in + /// the passed in holder. + ///</summary> + /// <param name="holder">a holder containing a certificate.</param> + /// <returns>an EncryptedValue containing the encrypted certificate.</returns> + /// <exception cref="CrmfException">on a failure to encrypt the data, or wrap the symmetric key for this value.</exception> + /// public EncryptedValue Build(X509Certificate holder) { try @@ -80,14 +79,14 @@ namespace Org.BouncyCastle.Crmf } } - /** - * Build an EncryptedValue structure containing the private key contained in - * the passed info structure. - * - * @param privateKeyInfo a PKCS#8 private key info structure. - * @return an EncryptedValue containing an EncryptedPrivateKeyInfo structure. - * @throws CrmfException on a failure to encrypt the data, or wrap the symmetric key for this value. - */ + ///<summary> + /// Build an EncryptedValue structure containing the private key contained in + /// the passed info structure. + ///</summary> + /// <param name="privateKeyInfo">a PKCS#8 private key info structure.</param> + /// <returns>an EncryptedValue containing an EncryptedPrivateKeyInfo structure.</returns> + /// <exception cref="CrmfException">on a failure to encrypt the data, or wrap the symmetric key for this value.</exception> + /// public EncryptedValue Build(PrivateKeyInfo privateKeyInfo) { Pkcs8EncryptedPrivateKeyInfoBuilder encInfoBldr = new Pkcs8EncryptedPrivateKeyInfoBuilder(privateKeyInfo); |