File: ASN1Strings.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (349 lines) | stat: -rw-r--r-- 12,081 bytes parent folder | download
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftASN1 open source project
//
// Copyright (c) 2021 Apple Inc. and the SwiftASN1 project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftASN1 project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

/// A UTF8String represents a string made up of UTF-8 bytes.
public struct ASN1UTF8String: DERImplicitlyTaggable, Hashable, Sendable, ExpressibleByStringLiteral {
    @inlinable
    public static var defaultIdentifier: ASN1Identifier {
        .utf8String
    }

    /// The raw bytes that make up this string.
    public var bytes: ArraySlice<UInt8>

    @inlinable
    public init(derEncoded node: ASN1Node, withIdentifier identifier: ASN1Identifier) throws {
        self.bytes = try ASN1OctetString(derEncoded: node, withIdentifier: identifier).bytes
    }

    /// Construct a UTF8STRING from raw bytes.
    @inlinable
    public init(contentBytes: ArraySlice<UInt8>) {
        self.bytes = contentBytes
    }

    @inlinable
    public init(stringLiteral value: StringLiteralType) {
        self.bytes = ArraySlice(value.utf8)
    }

    /// Construct a UTF8STRING from a String.
    @inlinable
    public init(_ string: String) {
        self.bytes = ArraySlice(string.utf8)
    }

    @inlinable
    public func serialize(into coder: inout DER.Serializer, withIdentifier identifier: ASN1Identifier) throws {
        let octet = ASN1OctetString(contentBytes: self.bytes)
        try octet.serialize(into: &coder, withIdentifier: identifier)
    }

    @inlinable
    public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
        return try self.bytes.withUnsafeBytes(body)
    }
}

/// TeletexString is an uncommon ASN.1 string type.
///
/// This module represents a TeletexString as an opaque sequence of bytes.
public struct ASN1TeletexString: DERImplicitlyTaggable, Hashable, Sendable, ExpressibleByStringLiteral {
    @inlinable
    public static var defaultIdentifier: ASN1Identifier {
        .teletexString
    }

    /// The raw bytes that make up this string.
    public var bytes: ArraySlice<UInt8>

    @inlinable
    public init(derEncoded node: ASN1Node, withIdentifier identifier: ASN1Identifier) throws {
        self.bytes = try ASN1OctetString(derEncoded: node, withIdentifier: identifier).bytes
    }

    /// Construct a TeletexString from raw bytes.
    @inlinable
    public init(contentBytes: ArraySlice<UInt8>) {
        self.bytes = contentBytes
    }

    @inlinable
    public init(stringLiteral value: StringLiteralType) {
        self.bytes = ArraySlice(value.utf8)
    }

    @inlinable
    public func serialize(into coder: inout DER.Serializer, withIdentifier identifier: ASN1Identifier) throws {
        let octet = ASN1OctetString(contentBytes: self.bytes)
        try octet.serialize(into: &coder, withIdentifier: identifier)
    }

    @inlinable
    public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
        return try self.bytes.withUnsafeBytes(body)
    }
}

/// PrintableString represents a String made up of bytes that can reliably be printed in a terminal.
///
/// This string will be validated when it is constructed, and will reject characters outside of this
/// space.
///
/// PrintableString is deprecated for most use-cases and generally ``ASN1UTF8String`` should be
/// preferred.
public struct ASN1PrintableString: DERImplicitlyTaggable, Hashable, Sendable, ExpressibleByStringLiteral {
    @inlinable
    public static var defaultIdentifier: ASN1Identifier {
        .printableString
    }

    /// The raw bytes that make up this string.
    public var bytes: ArraySlice<UInt8> {
        didSet {
            precondition(Self._isValid(self.bytes))
        }
    }

    @inlinable
    public init(derEncoded node: ASN1Node, withIdentifier identifier: ASN1Identifier) throws {
        self.bytes = try ASN1OctetString(derEncoded: node, withIdentifier: identifier).bytes
        guard Self._isValid(self.bytes) else {
            throw ASN1Error.invalidStringRepresentation(reason: "Invalid bytes for ASN1PrintableString")
        }
    }

    /// Construct a PrintableString from raw bytes.
    @inlinable
    public init(contentBytes: ArraySlice<UInt8>) throws {
        self.bytes = contentBytes
        guard Self._isValid(self.bytes) else {
            throw ASN1Error.invalidStringRepresentation(reason: "Invalid bytes for ASN1PrintableString")
        }
    }

    @inlinable
    public init(stringLiteral value: StringLiteralType) {
        self.bytes = ArraySlice(value.utf8)
        precondition(Self._isValid(self.bytes))
    }

    /// Construct a PrintableString from a String.
    @inlinable
    public init(_ string: String) throws {
        self.bytes = ArraySlice(string.utf8)

        guard Self._isValid(self.bytes) else {
            throw ASN1Error.invalidStringRepresentation(reason: "Invalid bytes for ASN1PrintableString")
        }
    }

    @inlinable
    public func serialize(into coder: inout DER.Serializer, withIdentifier identifier: ASN1Identifier) throws {
        let octet = ASN1OctetString(contentBytes: self.bytes)
        try octet.serialize(into: &coder, withIdentifier: identifier)
    }

    @inlinable
    public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
        return try self.bytes.withUnsafeBytes(body)
    }

    @inlinable
    static func _isValid(_ bytes: ArraySlice<UInt8>) -> Bool {
        bytes.allSatisfy {
            switch $0 {
            case UInt8(ascii: "a")...UInt8(ascii: "z"),
                UInt8(ascii: "A")...UInt8(ascii: "Z"),
                UInt8(ascii: "0")...UInt8(ascii: "9"),
                UInt8(ascii: "'"), UInt8(ascii: "("),
                UInt8(ascii: ")"), UInt8(ascii: "+"),
                UInt8(ascii: "-"), UInt8(ascii: "?"),
                UInt8(ascii: ":"), UInt8(ascii: "/"),
                UInt8(ascii: "="), UInt8(ascii: " "),
                UInt8(ascii: ","), UInt8(ascii: "."):
                return true
            default:
                return false
            }
        }
    }
}

/// UniversalString is an uncommon ASN.1 string type.
///
/// This module represents a UniversalString as an opaque sequence of bytes.
public struct ASN1UniversalString: DERImplicitlyTaggable, Hashable, Sendable, ExpressibleByStringLiteral {
    @inlinable
    public static var defaultIdentifier: ASN1Identifier {
        .universalString
    }

    /// The raw bytes that make up this string.
    public var bytes: ArraySlice<UInt8>

    @inlinable
    public init(derEncoded node: ASN1Node, withIdentifier identifier: ASN1Identifier) throws {
        self.bytes = try ASN1OctetString(derEncoded: node, withIdentifier: identifier).bytes
    }

    /// Construct a UniversalString from raw bytes.
    @inlinable
    public init(contentBytes: ArraySlice<UInt8>) {
        self.bytes = contentBytes
    }

    @inlinable
    public init(stringLiteral value: StringLiteralType) {
        self.bytes = ArraySlice(value.utf8)
    }

    @inlinable
    public func serialize(into coder: inout DER.Serializer, withIdentifier identifier: ASN1Identifier) throws {
        let octet = ASN1OctetString(contentBytes: self.bytes)
        try octet.serialize(into: &coder, withIdentifier: identifier)
    }

    @inlinable
    public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
        return try self.bytes.withUnsafeBytes(body)
    }
}

/// BMPString is an uncommon ASN.1 string type.
///
/// This module represents a BMPString as an opaque sequence of bytes.
public struct ASN1BMPString: DERImplicitlyTaggable, Hashable, Sendable, ExpressibleByStringLiteral {
    @inlinable
    public static var defaultIdentifier: ASN1Identifier {
        .bmpString
    }

    /// The raw bytes that make up this string.
    public var bytes: ArraySlice<UInt8>

    @inlinable
    public init(derEncoded node: ASN1Node, withIdentifier identifier: ASN1Identifier) throws {
        self.bytes = try ASN1OctetString(derEncoded: node, withIdentifier: identifier).bytes
    }

    /// Construct a BMPString from raw bytes.
    @inlinable
    public init(contentBytes: ArraySlice<UInt8>) {
        self.bytes = contentBytes
    }

    @inlinable
    public init(stringLiteral value: StringLiteralType) {
        self.bytes = ArraySlice(value.utf8)
    }

    @inlinable
    public func serialize(into coder: inout DER.Serializer, withIdentifier identifier: ASN1Identifier) throws {
        let octet = ASN1OctetString(contentBytes: self.bytes)
        try octet.serialize(into: &coder, withIdentifier: identifier)
    }

    @inlinable
    public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
        return try self.bytes.withUnsafeBytes(body)
    }
}

/// IA5String represents a String made up of ASCII characters.
///
/// This string will be validated when it is constructed, and will reject characters outside of this
/// space.
///
/// IA5String is deprecated for most use-cases and generally ``ASN1UTF8String`` should be
/// preferred.
public struct ASN1IA5String: DERImplicitlyTaggable, Hashable, Sendable, ExpressibleByStringLiteral {
    @inlinable
    public static var defaultIdentifier: ASN1Identifier {
        .ia5String
    }

    /// The raw bytes that make up this string.
    public var bytes: ArraySlice<UInt8> {
        didSet {
            precondition(Self._isValid(self.bytes))
        }
    }

    @inlinable
    public init(derEncoded node: ASN1Node, withIdentifier identifier: ASN1Identifier) throws {
        self.bytes = try ASN1OctetString(derEncoded: node, withIdentifier: identifier).bytes
        guard Self._isValid(self.bytes) else {
            throw ASN1Error.invalidStringRepresentation(reason: "Invalid bytes for ASN1IA5String")
        }
    }

    /// Construct an IA5String from raw bytes.
    @inlinable
    public init(contentBytes: ArraySlice<UInt8>) throws {
        self.bytes = contentBytes
        guard Self._isValid(self.bytes) else {
            throw ASN1Error.invalidStringRepresentation(reason: "Invalid bytes for ASN1IA5String")
        }
    }

    @inlinable
    public init(stringLiteral value: StringLiteralType) {
        self.bytes = ArraySlice(value.utf8)
        precondition(Self._isValid(self.bytes))
    }

    /// Construct an IA5String from a String.
    @inlinable
    public init(_ string: String) throws {
        self.bytes = ArraySlice(string.utf8)

        guard Self._isValid(self.bytes) else {
            throw ASN1Error.invalidStringRepresentation(reason: "Invalid bytes for ASN1IA5String")
        }
    }
    @inlinable
    public func serialize(into coder: inout DER.Serializer, withIdentifier identifier: ASN1Identifier) throws {
        let octet = ASN1OctetString(contentBytes: self.bytes)
        try octet.serialize(into: &coder, withIdentifier: identifier)
    }

    @inlinable
    public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
        return try self.bytes.withUnsafeBytes(body)
    }

    @inlinable
    static func _isValid(_ bytes: ArraySlice<UInt8>) -> Bool {
        // Valid IA5Strings are ASCII characters.
        bytes.allSatisfy { $0 < 128 }
    }
}

extension String {
    /// Construct a `String` from an ``ASN1UTF8String``.
    public init(_ utf8String: ASN1UTF8String) {
        self = String(decoding: utf8String.bytes, as: UTF8.self)
    }

    /// Construct a `String` from an ``ASN1PrintableString``.
    public init(_ printableString: ASN1PrintableString) {
        self = String(decoding: printableString.bytes, as: UTF8.self)
    }

    /// Construct a `String` from an ``ASN1IA5String``.
    public init(_ ia5String: ASN1IA5String) {
        self = String(decoding: ia5String.bytes, as: UTF8.self)
    }
}