summary refs log tree commit diff
path: root/crypto/src/asn1/tsp/EvidenceRecord.cs
blob: 1be8a399890a241bc28732f3064fb8675038ea98 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
using System;

using Org.BouncyCastle.Asn1.X509;
using Org.BouncyCastle.Utilities;

namespace Org.BouncyCastle.Asn1.Tsp
{
    /**
     * <a href="https://tools.ietf.org/html/rfc4998">RFC 4998</a>:
     * Evidence Record Syntax (ERS)
     * <p/>
     * <pre>
     * EvidenceRecord ::= SEQUENCE {
     *   version                   INTEGER { v1(1) } ,
     *   digestAlgorithms          SEQUENCE OF AlgorithmIdentifier,
     *   cryptoInfos               [0] CryptoInfos OPTIONAL,
     *   encryptionInfo            [1] EncryptionInfo OPTIONAL,
     *   archiveTimeStampSequence  ArchiveTimeStampSequence
     * }
     *
     * CryptoInfos ::= SEQUENCE SIZE (1..MAX) OF Attribute
     * </pre>
     */
    public class EvidenceRecord
        : Asn1Encodable
    {
        /**
         * ERS {iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) ltans(11)
         * id-mod(0) id-mod-ers88(2) id-mod-ers88-v1(1) }
         */
        private static readonly DerObjectIdentifier Oid = new DerObjectIdentifier("1.3.6.1.5.5.11.0.2.1");

        /**
         * Return an EvidenceRecord from the given object.
         *
         * @param obj the object we want converted.
         * @return an EvidenceRecord instance, or null.
         * @throws IllegalArgumentException if the object cannot be converted.
         */
        public static EvidenceRecord GetInstance(object obj)
        {
            if (obj == null)
                return null;
            if (obj is EvidenceRecord evidenceRecord)
                return evidenceRecord;
            return new EvidenceRecord(Asn1Sequence.GetInstance(obj));
        }

        public static EvidenceRecord GetInstance(Asn1TaggedObject taggedObject, bool declaredExplicit)
        {
            return new EvidenceRecord(Asn1Sequence.GetInstance(taggedObject, declaredExplicit));
        }

        private readonly DerInteger m_version;
        private readonly Asn1Sequence m_digestAlgorithms;
        private readonly CryptoInfos m_cryptoInfos;
        private readonly EncryptionInfo m_encryptionInfo;
        private readonly ArchiveTimeStampSequence m_archiveTimeStampSequence;

        private EvidenceRecord(EvidenceRecord evidenceRecord, ArchiveTimeStampSequence replacementSequence,
            ArchiveTimeStamp newChainTimeStamp)
        {
            m_version = evidenceRecord.m_version;

            // check the list of digest algorithms is correct.
            if (newChainTimeStamp != null)
            {
                AlgorithmIdentifier algID = newChainTimeStamp.GetDigestAlgorithmIdentifier();
                Asn1EncodableVector vector = new Asn1EncodableVector();

                bool found = false;

                foreach (var element in evidenceRecord.m_digestAlgorithms)
                {
                    AlgorithmIdentifier algorithmIdentifier = AlgorithmIdentifier.GetInstance(element);
                    vector.Add(algorithmIdentifier);

                    if (algorithmIdentifier.Equals(algID))
                    {
                        found = true;
                        break;
                    }
                }

                if (!found)
                {
                    vector.Add(algID);
                    m_digestAlgorithms = new DerSequence(vector);
                }
                else
                {
                    m_digestAlgorithms = evidenceRecord.m_digestAlgorithms;
                }
            }
            else
            {
                m_digestAlgorithms = evidenceRecord.m_digestAlgorithms;
            }

            m_cryptoInfos = evidenceRecord.m_cryptoInfos;
            m_encryptionInfo = evidenceRecord.m_encryptionInfo;
            m_archiveTimeStampSequence = replacementSequence;
        }

        /**
         * Build a basic evidence record from an initial
         * ArchiveTimeStamp.
         * 
         * @param cryptoInfos
         * @param encryptionInfo
         * @param archiveTimeStamp
         */
        public EvidenceRecord(CryptoInfos cryptoInfos, EncryptionInfo encryptionInfo, ArchiveTimeStamp archiveTimeStamp)
        {
            m_version = new DerInteger(1);
            m_digestAlgorithms = new DerSequence(archiveTimeStamp.GetDigestAlgorithmIdentifier());
            m_cryptoInfos = cryptoInfos;
            m_encryptionInfo = encryptionInfo;
            m_archiveTimeStampSequence = new ArchiveTimeStampSequence(new ArchiveTimeStampChain(archiveTimeStamp));
        }

        public EvidenceRecord(AlgorithmIdentifier[] digestAlgorithms, CryptoInfos cryptoInfos,
            EncryptionInfo encryptionInfo, ArchiveTimeStampSequence archiveTimeStampSequence)
        {
            m_version = new DerInteger(1);
            m_digestAlgorithms = new DerSequence(digestAlgorithms);
            m_cryptoInfos = cryptoInfos;
            m_encryptionInfo = encryptionInfo;
            m_archiveTimeStampSequence = archiveTimeStampSequence;
        }

        private EvidenceRecord(Asn1Sequence sequence)
        {
            if (sequence.Count < 3 && sequence.Count > 5)
                throw new ArgumentException("wrong sequence size in constructor: " + sequence.Count, nameof(sequence));

            DerInteger versionNumber = DerInteger.GetInstance(sequence[0]);
            if (!versionNumber.HasValue(1))
                throw new ArgumentException("incompatible version");

            m_version = versionNumber;

            m_digestAlgorithms = Asn1Sequence.GetInstance(sequence[1]);
            for (int i = 2; i != sequence.Count - 1; i++)
            {
                Asn1Encodable element = sequence[i];

                if (element is Asn1TaggedObject asn1TaggedObject)
                {
                    switch (asn1TaggedObject.TagNo)
                    {
                    case 0:
                        m_cryptoInfos = CryptoInfos.GetInstance(asn1TaggedObject, false);
                        break;
                    case 1:
                        m_encryptionInfo = EncryptionInfo.GetInstance(asn1TaggedObject, false);
                        break;
                    default:
                        throw new ArgumentException("unknown tag in GetInstance: " + asn1TaggedObject.TagNo);
                    }
                }
                else
                {
                    throw new ArgumentException("unknown object in GetInstance: " + Platform.GetTypeName(element));
                }
            }
            m_archiveTimeStampSequence = ArchiveTimeStampSequence.GetInstance(sequence[sequence.Count - 1]);
        }

        public virtual AlgorithmIdentifier[] GetDigestAlgorithms() =>
            m_digestAlgorithms.MapElements(AlgorithmIdentifier.GetInstance);

        public virtual ArchiveTimeStampSequence ArchiveTimeStampSequence => m_archiveTimeStampSequence;

        /**
         * Return a new EvidenceRecord with an added ArchiveTimeStamp
         *
         * @param ats         the archive timestamp to add
         * @param newChain states whether this new archive timestamp must be added as part of a
         *                    new sequence (i.e. in the case of hashtree renewal) or not (i.e. in the case of timestamp
         *                    renewal)
         * @return the new EvidenceRecord
         */
        public virtual EvidenceRecord AddArchiveTimeStamp(ArchiveTimeStamp ats, bool newChain)
        {
            if (newChain)
            {
                ArchiveTimeStampChain chain = new ArchiveTimeStampChain(ats);

                return new EvidenceRecord(this, m_archiveTimeStampSequence.Append(chain), ats);
            }
            else
            {
                ArchiveTimeStampChain[] chains = m_archiveTimeStampSequence.GetArchiveTimeStampChains();

                AlgorithmIdentifier digAlg = chains[chains.Length - 1].GetArchiveTimestamps()[0]
                    .GetDigestAlgorithmIdentifier();
                if (!digAlg.Equals(ats.GetDigestAlgorithmIdentifier()))
                    throw new ArgumentException("mismatch of digest algorithm in AddArchiveTimeStamp");

                chains[chains.Length - 1] = chains[chains.Length - 1].Append(ats);
                return new EvidenceRecord(this, new ArchiveTimeStampSequence(chains), null);
            }
        }

        public override Asn1Object ToAsn1Object()
        {
            Asn1EncodableVector vector = new Asn1EncodableVector(5);
            vector.Add(m_version);
            vector.Add(m_digestAlgorithms);
            vector.AddOptionalTagged(false, 0, m_cryptoInfos);
            vector.AddOptionalTagged(false, 1, m_encryptionInfo);
            vector.Add(m_archiveTimeStampSequence);
            return new DerSequence(vector);
        }
    }
}