File: CertificatePrivateKey.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 (311 lines) | stat: -rw-r--r-- 12,074 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftCertificates open source project
//
// Copyright (c) 2022 Apple Inc. and the SwiftCertificates project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftCertificates project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

import SwiftASN1
import Foundation
@preconcurrency import Crypto
@preconcurrency import _CryptoExtras

extension Certificate {
    /// A private key that can be used with a certificate.
    ///
    /// This type provides an opaque wrapper around the various private key types
    /// provided by `swift-crypto`. Users are expected to construct this key from
    /// one of those types.
    ///
    /// As private keys are never sent over the wire, this type does not offer
    /// support for being unwrapped back into the underlying key types.
    public struct PrivateKey {
        @usableFromInline
        var backing: BackingPrivateKey

        @inlinable
        internal init(backing: BackingPrivateKey) {
            self.backing = backing
        }

        /// Construct a private key wrapping a P256 private key.
        /// - Parameter p256: The P256 private key to wrap.
        @inlinable
        public init(_ p256: P256.Signing.PrivateKey) {
            self.backing = .p256(p256)
        }

        /// Construct a private key wrapping a P384 private key.
        /// - Parameter p384: The P384 private key to wrap.
        @inlinable
        public init(_ p384: P384.Signing.PrivateKey) {
            self.backing = .p384(p384)
        }

        /// Construct a private key wrapping a P521 private key.
        /// - Parameter p521: The P521 private key to wrap.
        @inlinable
        public init(_ p521: P521.Signing.PrivateKey) {
            self.backing = .p521(p521)
        }

        /// Construct a private key wrapping a RSA private key.
        /// - Parameter rsa: The RSA private key to wrap.
        @inlinable
        public init(_ rsa: _RSA.Signing.PrivateKey) {
            self.backing = .rsa(rsa)
        }

        #if canImport(Darwin)
        /// Construct a private key wrapping a SecureEnclave.P256 private key.
        /// - Parameter secureEnclaveP256: The SecureEnclave.P256 private key to wrap.
        @inlinable
        public init(_ secureEnclaveP256: SecureEnclave.P256.Signing.PrivateKey) {
            self.backing = .secureEnclaveP256(secureEnclaveP256)
        }
        #endif

        @inlinable
        internal func sign<Bytes: DataProtocol>(
            bytes: Bytes,
            signatureAlgorithm: SignatureAlgorithm
        ) throws -> Signature {
            try self.validateAlgorithmForKey(algorithm: signatureAlgorithm)
            let digestAlgorithm = try AlgorithmIdentifier(digestAlgorithmFor: signatureAlgorithm)

            switch self.backing {
            case .p256(let p256):
                return try p256.signature(for: bytes, digestAlgorithm: digestAlgorithm)
            case .p384(let p384):
                return try p384.signature(for: bytes, digestAlgorithm: digestAlgorithm)
            case .p521(let p521):
                return try p521.signature(for: bytes, digestAlgorithm: digestAlgorithm)
            case .rsa(let rsa):
                let padding = try _RSA.Signing.Padding(forSignatureAlgorithm: signatureAlgorithm)
                return try rsa.signature(for: bytes, digestAlgorithm: digestAlgorithm, padding: padding)
            #if canImport(Darwin)
            case .secureEnclaveP256(let secureEnclaveP256):
                return try secureEnclaveP256.signature(for: bytes, digestAlgorithm: digestAlgorithm)
            #endif
            }
        }

        /// Obtain the ``Certificate/PublicKey-swift.struct`` corresponding to
        /// this private key.
        @inlinable
        public var publicKey: PublicKey {
            switch self.backing {
            case .p256(let p256):
                return PublicKey(p256.publicKey)
            case .p384(let p384):
                return PublicKey(p384.publicKey)
            case .p521(let p521):
                return PublicKey(p521.publicKey)
            case .rsa(let rsa):
                return PublicKey(rsa.publicKey)
            #if canImport(Darwin)
            case .secureEnclaveP256(let secureEnclaveP256):
                return PublicKey(secureEnclaveP256.publicKey)
            #endif
            }
        }

        @inlinable
        func validateAlgorithmForKey(algorithm: SignatureAlgorithm) throws {
            switch self.backing {
            case .p256, .p384, .p521:
                if !algorithm.isECDSA {
                    throw CertificateError.unsupportedSignatureAlgorithm(
                        reason: "Cannot use \(algorithm) with ECDSA key \(self)"
                    )
                }
            case .rsa:
                if !algorithm.isRSA {
                    throw CertificateError.unsupportedSignatureAlgorithm(
                        reason: "Cannot use \(algorithm) with RSA key \(self)"
                    )
                }
            #if canImport(Darwin)
            case .secureEnclaveP256:
                if !algorithm.isECDSA {
                    throw CertificateError.unsupportedSignatureAlgorithm(
                        reason: "Cannot use \(algorithm) with ECDSA key \(self)"
                    )
                }
            #endif
            }

        }
    }
}

extension Certificate.PrivateKey: Hashable {}

extension Certificate.PrivateKey: Sendable {}

extension Certificate.PrivateKey: CustomStringConvertible {
    public var description: String {
        switch self.backing {
        case .p256:
            return "P256.PrivateKey"
        case .p384:
            return "P384.PrivateKey"
        case .p521:
            return "P521.PrivateKey"
        case .rsa(let publicKey):
            return "RSA\(publicKey.keySizeInBits).PrivateKey"
        #if canImport(Darwin)
        case .secureEnclaveP256:
            return "SecureEnclave.P256.PrivateKey"
        #endif
        }
    }
}

extension Certificate.PrivateKey {
    @usableFromInline
    enum BackingPrivateKey: Hashable, Sendable {
        case p256(Crypto.P256.Signing.PrivateKey)
        case p384(Crypto.P384.Signing.PrivateKey)
        case p521(Crypto.P521.Signing.PrivateKey)
        case rsa(_CryptoExtras._RSA.Signing.PrivateKey)
        #if canImport(Darwin)
        case secureEnclaveP256(SecureEnclave.P256.Signing.PrivateKey)
        #endif

        @inlinable
        static func == (lhs: BackingPrivateKey, rhs: BackingPrivateKey) -> Bool {
            switch (lhs, rhs) {
            case (.p256(let l), .p256(let r)):
                return l.rawRepresentation == r.rawRepresentation
            case (.p384(let l), .p384(let r)):
                return l.rawRepresentation == r.rawRepresentation
            case (.p521(let l), .p521(let r)):
                return l.rawRepresentation == r.rawRepresentation
            case (.rsa(let l), .rsa(let r)):
                return l.derRepresentation == r.derRepresentation
            #if canImport(Darwin)
            case (.secureEnclaveP256(let l), .secureEnclaveP256(let r)):
                return l.dataRepresentation == r.dataRepresentation
            #endif
            default:
                return false
            }
        }

        @inlinable
        func hash(into hasher: inout Hasher) {
            switch self {
            case .p256(let digest):
                hasher.combine(0)
                hasher.combine(digest.rawRepresentation)
            case .p384(let digest):
                hasher.combine(1)
                hasher.combine(digest.rawRepresentation)
            case .p521(let digest):
                hasher.combine(2)
                hasher.combine(digest.rawRepresentation)
            case .rsa(let digest):
                hasher.combine(3)
                hasher.combine(digest.derRepresentation)
            #if canImport(Darwin)
            case .secureEnclaveP256(let digest):
                hasher.combine(4)
                hasher.combine(digest.dataRepresentation)
            #endif
            }
        }
    }
}

@available(macOS 11.0, iOS 14, tvOS 14, watchOS 7, *)
extension Certificate.PrivateKey {
    @inlinable
    static var pemDiscriminatorForRSA: String { "RSA PRIVATE KEY" }

    @inlinable
    static var pemDiscriminatorForSEC1: String { "EC PRIVATE KEY" }

    @inlinable
    static var pemDiscriminatorForPKCS8: String { "PRIVATE KEY" }

    @inlinable
    public init(pemEncoded: String) throws {
        try self.init(pemDocument: PEMDocument(pemString: pemEncoded))
    }

    @inlinable
    public init(pemDocument: PEMDocument) throws {
        switch pemDocument.discriminator {
        case Self.pemDiscriminatorForRSA:
            self = try .init(_CryptoExtras._RSA.Signing.PrivateKey.init(derRepresentation: pemDocument.derBytes))

        case Self.pemDiscriminatorForSEC1:
            let sec1 = try SEC1PrivateKey(derEncoded: pemDocument.derBytes)
            self = try .init(ecdsaAlgorithm: sec1.algorithm, rawEncodedPrivateKey: sec1.privateKey.bytes)

        case Self.pemDiscriminatorForPKCS8:
            let pkcs8 = try PKCS8PrivateKey(derEncoded: pemDocument.derBytes)
            switch pkcs8.algorithm {
            case .ecdsaP256, .ecdsaP384, .ecdsaP521:
                let sec1 = try SEC1PrivateKey(derEncoded: pkcs8.privateKey.bytes)
                if let innerAlgorithm = sec1.algorithm, innerAlgorithm != pkcs8.algorithm {
                    throw ASN1Error.invalidASN1Object(
                        reason: "algorithm mismatch. PKCS#8 is \(pkcs8.algorithm) but inner SEC1 is \(innerAlgorithm)"
                    )
                }
                self = try .init(ecdsaAlgorithm: pkcs8.algorithm, rawEncodedPrivateKey: sec1.privateKey.bytes)

            case .rsaKey:
                self = try .init(_CryptoExtras._RSA.Signing.PrivateKey(derRepresentation: pkcs8.privateKey.bytes))
            default:
                throw CertificateError.unsupportedPrivateKey(reason: "unknown algorithm \(pkcs8.algorithm)")
            }

        default:
            throw ASN1Error.invalidPEMDocument(
                reason:
                    "PEMDocument has incorrect discriminator \(pemDocument.discriminator). Expected \(Self.pemDiscriminatorForPKCS8), \(Self.pemDiscriminatorForSEC1) or \(Self.pemDiscriminatorForRSA) instead"
            )
        }
    }

    @inlinable
    init(ecdsaAlgorithm: AlgorithmIdentifier?, rawEncodedPrivateKey: ArraySlice<UInt8>) throws {
        switch ecdsaAlgorithm {
        case .some(.ecdsaP256):
            self = try .init(P256.Signing.PrivateKey(rawRepresentation: rawEncodedPrivateKey))
        case .some(.ecdsaP384):
            self = try .init(P384.Signing.PrivateKey(rawRepresentation: rawEncodedPrivateKey))
        case .some(.ecdsaP521):
            self = try .init(P521.Signing.PrivateKey(rawRepresentation: rawEncodedPrivateKey))
        default:
            throw CertificateError.unsupportedPrivateKey(
                reason: "unknown algorithm \(String(reflecting: ecdsaAlgorithm))"
            )
        }
    }

    @inlinable
    public func serializeAsPEM() throws -> PEMDocument {
        switch backing {
        case .p256(let key): return try PEMDocument(pemString: key.pemRepresentation)
        case .p384(let key): return try PEMDocument(pemString: key.pemRepresentation)
        case .p521(let key): return try PEMDocument(pemString: key.pemRepresentation)
        case .rsa(let key): return try PEMDocument(pemString: key.pemRepresentation)
        #if canImport(Darwin)
        case .secureEnclaveP256:
            throw CertificateError.unsupportedPrivateKey(
                reason: "secure enclave private keys can not be serialised as PEM"
            )
        #endif
        }
    }
}