CMSSignedGenerator.cs

using System;
using System.Collections.Generic;

using Org.BouncyCastle.Asn1;
using Org.BouncyCastle.Asn1.Cms;
using Org.BouncyCastle.Asn1.CryptoPro;
using Org.BouncyCastle.Asn1.GM;
using Org.BouncyCastle.Asn1.Nist;
using Org.BouncyCastle.Asn1.Oiw;
using Org.BouncyCastle.Asn1.Pkcs;
using Org.BouncyCastle.Asn1.Rosstandart;
using Org.BouncyCastle.Asn1.TeleTrust;
using Org.BouncyCastle.Asn1.X509;
using Org.BouncyCastle.Asn1.X9;
using Org.BouncyCastle.Crypto;
using Org.BouncyCastle.Operators.Utilities;
using Org.BouncyCastle.Security;
using Org.BouncyCastle.Utilities.Collections;
using Org.BouncyCastle.X509;

namespace Org.BouncyCastle.Cms
{
    [Obsolete("Use 'Org.BouncyCastle.Operators.Utilities.DefaultSignatureAlgorithmFinder' instead")]
    public class DefaultSignatureAlgorithmIdentifierFinder
        : Operators.Utilities.ISignatureAlgorithmFinder
    {
        // TODO[api] Make virtual
        public AlgorithmIdentifier Find(string sigAlgName) =>
            Operators.Utilities.DefaultSignatureAlgorithmFinder.Instance.Find(sigAlgName);
    }

    [Obsolete("Use 'Org.BouncyCastle.Operators.Utilities.DefaultDigestAlgorithmFinder' instead")]
    public class DefaultDigestAlgorithmIdentifierFinder
        : Operators.Utilities.IDigestAlgorithmFinder
    {
        // TODO[api] Make virtual
        public AlgorithmIdentifier Find(AlgorithmIdentifier sigAlgId) =>
            Operators.Utilities.DefaultDigestAlgorithmFinder.Instance.Find(sigAlgId);

        public virtual AlgorithmIdentifier Find(DerObjectIdentifier digAlgOid) =>
            Operators.Utilities.DefaultDigestAlgorithmFinder.Instance.Find(digAlgOid);

        // TODO[api] Make virtual
        public AlgorithmIdentifier Find(string digAlgName) =>
            Operators.Utilities.DefaultDigestAlgorithmFinder.Instance.Find(digAlgName);
    }

    public abstract class CmsSignedGenerator
    {
        /**
         * Default type for the signed data.
         */
        public static readonly string Data = CmsObjectIdentifiers.Data.Id;

        public static readonly string DigestSha1 = OiwObjectIdentifiers.IdSha1.Id;
        public static readonly string DigestSha224 = NistObjectIdentifiers.IdSha224.Id;
        public static readonly string DigestSha256 = NistObjectIdentifiers.IdSha256.Id;
        public static readonly string DigestSha384 = NistObjectIdentifiers.IdSha384.Id;
        public static readonly string DigestSha512 = NistObjectIdentifiers.IdSha512.Id;
        public static readonly string DigestSha512_224 = NistObjectIdentifiers.IdSha512_224.Id;
        public static readonly string DigestSha512_256 = NistObjectIdentifiers.IdSha512_256.Id;

        public static readonly string DigestSha3_224 = NistObjectIdentifiers.IdSha3_224.Id;
        public static readonly string DigestSha3_256 = NistObjectIdentifiers.IdSha3_256.Id;
        public static readonly string DigestSha3_384 = NistObjectIdentifiers.IdSha3_384.Id;
        public static readonly string DigestSha3_512 = NistObjectIdentifiers.IdSha3_512.Id;

        public static readonly string DigestShake128 = NistObjectIdentifiers.IdShake128.Id;
        public static readonly string DigestShake256 = NistObjectIdentifiers.IdShake256.Id;

        public static readonly string DigestMD5 = PkcsObjectIdentifiers.MD5.Id;
        public static readonly string DigestGost3411 = CryptoProObjectIdentifiers.GostR3411.Id;
        public static readonly string DigestRipeMD128 = TeleTrusTObjectIdentifiers.RipeMD128.Id;
        public static readonly string DigestRipeMD160 = TeleTrusTObjectIdentifiers.RipeMD160.Id;
        public static readonly string DigestRipeMD256 = TeleTrusTObjectIdentifiers.RipeMD256.Id;
        public static readonly string DigestSM3 = GMObjectIdentifiers.sm3.Id;

        public static readonly string EncryptionRsa = PkcsObjectIdentifiers.RsaEncryption.Id;
        public static readonly string EncryptionDsa = X9ObjectIdentifiers.IdDsaWithSha1.Id;
        public static readonly string EncryptionECDsa = X9ObjectIdentifiers.ECDsaWithSha1.Id;
        public static readonly string EncryptionRsaPss = PkcsObjectIdentifiers.IdRsassaPss.Id;
        public static readonly string EncryptionGost3410 = CryptoProObjectIdentifiers.GostR3410x94.Id;
        public static readonly string EncryptionECGost3410 = CryptoProObjectIdentifiers.GostR3410x2001.Id;
        public static readonly string EncryptionECGost3410_2012_256 = RosstandartObjectIdentifiers.id_tc26_gost_3410_12_256.Id;
        public static readonly string EncryptionECGost3410_2012_512 = RosstandartObjectIdentifiers.id_tc26_gost_3410_12_512.Id;

        internal List<Asn1Encodable> _certs = new List<Asn1Encodable>();
        internal List<Asn1Encodable> _crls = new List<Asn1Encodable>();
        internal List<SignerInformation> _signers = new List<SignerInformation>();
        internal Dictionary<DerObjectIdentifier, byte[]> m_digests = new Dictionary<DerObjectIdentifier, byte[]>();
        internal IDigestAlgorithmFinder m_digestAlgorithmFinder = DefaultDigestAlgorithmFinder.Instance;
        internal bool _useDerForCerts = false;
        internal bool _useDerForCrls = false;

        // TODO[api] Restrict to internal
        protected readonly SecureRandom m_random;

        // TODO[api] Restrict to internal
        protected CmsSignedGenerator()
            : this(CryptoServicesRegistrar.GetSecureRandom())
        {
        }

        /// <summary>Constructor allowing specific source of randomness</summary>
        /// <param name="random">Instance of <c>SecureRandom</c> to use.</param>
        // TODO[api] Restrict to internal
        protected CmsSignedGenerator(SecureRandom random)
        {
            m_random = random ?? throw new ArgumentNullException(nameof(random));
        }

        // TODO[api] After removing this, SignatureAlgorithmIdentifier can be assumed present in
        // DefaultSignedAttributeTableGenerator.AddMissingStandardAttributes
        [Obsolete("Will be removed")]
        protected internal virtual IDictionary<CmsAttributeTableParameter, object> GetBaseParameters(
            DerObjectIdentifier contentType, AlgorithmIdentifier digAlgId, byte[] hash)
        {
            var param = new Dictionary<CmsAttributeTableParameter, object>();

            if (contentType != null)
            {
                param[CmsAttributeTableParameter.ContentType] = contentType;
            }

            param[CmsAttributeTableParameter.DigestAlgorithmIdentifier] = digAlgId;
            param[CmsAttributeTableParameter.Digest] = hash.Clone();

            return param;
        }

        internal virtual IDictionary<CmsAttributeTableParameter, object> GetBaseParameters(
            DerObjectIdentifier contentType, AlgorithmIdentifier digAlgID, AlgorithmIdentifier sigAlgID, byte[] hash)
        {
            var param = new Dictionary<CmsAttributeTableParameter, object>();

            if (contentType != null)
            {
                param[CmsAttributeTableParameter.ContentType] = contentType;
            }

            param[CmsAttributeTableParameter.DigestAlgorithmIdentifier] = digAlgID;
            param[CmsAttributeTableParameter.SignatureAlgorithmIdentifier] = sigAlgID;
            param[CmsAttributeTableParameter.Digest] = hash.Clone();

            return param;
        }

        // TODO[api] Restrict to internal
        protected internal virtual Asn1Set GetAttributeSet(Asn1.Cms.AttributeTable attr)
        {
            return attr == null ? null : DerSet.FromCollection(attr);
        }

        public void AddAttributeCertificate(X509V2AttributeCertificate attrCert) =>
            CmsUtilities.CollectAttributeCertificate(_certs, attrCert);

        public void AddAttributeCertificates(IStore<X509V2AttributeCertificate> attrCertStore) =>
            CmsUtilities.CollectAttributeCertificates(_certs, attrCertStore);

        public void AddCertificate(X509Certificate cert) => CmsUtilities.CollectCertificate(_certs, cert);

        public void AddCertificates(IStore<X509Certificate> certStore) =>
            CmsUtilities.CollectCertificates(_certs, certStore);

        public void AddCrl(X509Crl crl) => CmsUtilities.CollectCrl(_crls, crl);

        public void AddCrls(IStore<X509Crl> crlStore) => CmsUtilities.CollectCrls(_crls, crlStore);

        public void AddOtherRevocationInfo(OtherRevocationInfoFormat otherRevocationInfo) =>
            CmsUtilities.CollectOtherRevocationInfo(_crls, otherRevocationInfo);

        public void AddOtherRevocationInfo(DerObjectIdentifier otherRevInfoFormat, Asn1Encodable otherRevInfo) =>
            CmsUtilities.CollectOtherRevocationInfo(_crls, otherRevInfoFormat, otherRevInfo);

        public void AddOtherRevocationInfos(IStore<OtherRevocationInfoFormat> otherRevocationInfoStore) =>
            CmsUtilities.CollectOtherRevocationInfos(_crls, otherRevocationInfoStore);

        public void AddOtherRevocationInfos(DerObjectIdentifier otherRevInfoFormat,
            IStore<Asn1Encodable> otherRevInfoStore)
        {
            CmsUtilities.CollectOtherRevocationInfos(_crls, otherRevInfoFormat, otherRevInfoStore);
        }

        /**
         * Add a store of precalculated signers to the generator.
         *
         * @param signerStore store of signers
         */
        public void AddSigners(SignerInformationStore signerStore)
        {
            foreach (SignerInformation o in signerStore.SignersInternal)
            {
                _signers.Add(o);
                AddSignerCallback(o);
            }
        }

        public IDigestAlgorithmFinder DigestAlgorithmFinder
        {
            get { return m_digestAlgorithmFinder; }
            set { m_digestAlgorithmFinder = value ?? throw new ArgumentNullException(nameof(value)); }
        }

        /**
         * Return a map of oids and byte arrays representing the digests calculated on the content during
         * the last generate.
         *
         * @return a map of oids (as string objects) and byte[] representing digests.
         */
        // TODO[api] Prefer to return just a copy of m_digests (i.e. keyed by DerObjectIdentifier)?
        public IDictionary<string, byte[]> GetGeneratedDigests()
        {
            var result = new Dictionary<string, byte[]>(StringComparer.OrdinalIgnoreCase);
            foreach (var entry in m_digests)
            {
                result.Add(entry.Key.GetID(), entry.Value);
            }
            return result;
        }

        [Obsolete("Will be removed. Replaced in CmsSignedDataGenerator by the similar 'UseDefiniteLength' property")]
        public bool UseDerForCerts
        {
            get { return _useDerForCerts; }
            set { this._useDerForCerts = value; }
        }

        [Obsolete("Will be removed. Replaced in CmsSignedDataGenerator by the similar 'UseDefiniteLength' property")]
        public bool UseDerForCrls
        {
            get { return _useDerForCrls; }
            set { this._useDerForCrls = value; }
        }

        internal virtual void AddSignerCallback(SignerInformation signerInformation)
        {
        }

        internal static SignerIdentifier GetSignerIdentifier(X509Certificate c) => CmsUtilities.GetSignerIdentifier(c);

        internal static SignerIdentifier GetSignerIdentifier(byte[] subjectKeyIdentifier) =>
            CmsUtilities.GetSignerIdentifier(subjectKeyIdentifier);
    }
}