File: SignatureAlgorithm.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 (144 lines) | stat: -rw-r--r-- 6,009 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

extension Certificate {
    /// A representation of a kind of signature algorithm.
    ///
    /// X.509 certificates support a wide range of signature algorithms. This type
    /// identifies the algorithm, independently of the signature itself.
    ///
    /// This type represents an unbounded enumeration. There are potentially infinite
    /// signature algorithms. Users are able to create representations of the signature
    /// algorithms this library supports by using static fields on this type.
    public struct SignatureAlgorithm {
        @usableFromInline
        var _algorithmIdentifier: AlgorithmIdentifier

        @inlinable
        init(algorithmIdentifier: AlgorithmIdentifier) {
            switch algorithmIdentifier {
            // Per RFC 4055 § 5, we need to accept the RSA parameters field being
            // absent, but we must _produce_ the one with an explicit NULL. So we
            // normalise the signature algorithm here.
            case .sha1WithRSAEncryptionUsingNil:
                self._algorithmIdentifier = .sha1WithRSAEncryption
            case .sha256WithRSAEncryptionUsingNil:
                self._algorithmIdentifier = .sha256WithRSAEncryption
            case .sha384WithRSAEncryptionUsingNil:
                self._algorithmIdentifier = .sha384WithRSAEncryption
            case .sha512WithRSAEncryptionUsingNil:
                self._algorithmIdentifier = .sha512WithRSAEncryption
            case let identifier:
                self._algorithmIdentifier = identifier
            }
        }

        /// This value represents an ECDSA signature using SHA256 and P256.
        public static let ecdsaWithSHA256 = Self(algorithmIdentifier: .ecdsaWithSHA256)

        /// This value represents an ECDSA signature using SHA384 and P384.
        public static let ecdsaWithSHA384 = Self(algorithmIdentifier: .ecdsaWithSHA384)

        /// This value represents an ECDSA signature using SHA512 and P521.
        public static let ecdsaWithSHA512 = Self(algorithmIdentifier: .ecdsaWithSHA512)

        /// This value represents an RSA signature with PKCS1v1.5 padding and SHA1 as the hash function.
        public static let sha1WithRSAEncryption = Self(algorithmIdentifier: .sha1WithRSAEncryption)

        /// This value represents an RSA signature with PKCS1v1.5 padding and SHA256 as the hash function.
        public static let sha256WithRSAEncryption = Self(algorithmIdentifier: .sha256WithRSAEncryption)

        /// This value represents an RSA signature with PKCS1v1.5 padding and SHA384 as the hash function.
        public static let sha384WithRSAEncryption = Self(algorithmIdentifier: .sha384WithRSAEncryption)

        /// This value represents an RSA signature with PKCS1v1.5 padding and SHA521 as the hash function.
        public static let sha512WithRSAEncryption = Self(algorithmIdentifier: .sha512WithRSAEncryption)

        /// Whether this algorithm represents an ECDSA signature.
        @inlinable
        var isECDSA: Bool {
            switch self {
            case .ecdsaWithSHA256, .ecdsaWithSHA384, .ecdsaWithSHA512:
                return true
            default:
                return false
            }
        }

        @inlinable
        var isRSA: Bool {
            switch self {
            case .sha1WithRSAEncryption, .sha256WithRSAEncryption, .sha384WithRSAEncryption, .sha512WithRSAEncryption:
                return true
            default:
                return false
            }
        }
    }
}

extension Certificate.SignatureAlgorithm: Hashable {}

extension Certificate.SignatureAlgorithm: Sendable {}

extension Certificate.SignatureAlgorithm: CustomStringConvertible {
    public var description: String {
        switch self {
        case .ecdsaWithSHA256:
            return "SignatureAlgorithm.ecdsaWithSHA256"
        case .ecdsaWithSHA384:
            return "SignatureAlgorithm.ecdsaWithSHA384"
        case .ecdsaWithSHA512:
            return "SignatureAlgorithm.ecdsaWithSHA512"
        case .sha1WithRSAEncryption:
            return "SignatureAlgorithm.sha1WithRSAEncryption"
        case .sha256WithRSAEncryption:
            return "SignatureAlgorithm.sha256WithRSAEncryption"
        case .sha384WithRSAEncryption:
            return "SignatureAlgorithm.sha384WithRSAEncryption"
        case .sha512WithRSAEncryption:
            return "SignatureAlgorithm.sha512WithRSAEncryption"
        default:
            return "SignatureAlgorithm(\(self._algorithmIdentifier))"
        }

    }
}

extension AlgorithmIdentifier {
    @inlinable
    init(_ signatureAlgorithm: Certificate.SignatureAlgorithm) {
        self = signatureAlgorithm._algorithmIdentifier
    }

    @inlinable
    init(digestAlgorithmFor signatureAlgorithm: Certificate.SignatureAlgorithm) throws {
        // Per RFC 5754 § 2, we must produce digest algorithm identifiers with
        // absent parameters, so we do.
        switch signatureAlgorithm {
        case .ecdsaWithSHA256, .sha256WithRSAEncryption:
            self = .sha256UsingNil
        case .ecdsaWithSHA384, .sha384WithRSAEncryption:
            self = .sha384UsingNil
        case .ecdsaWithSHA512, .sha512WithRSAEncryption:
            self = .sha512UsingNil
        case .sha1WithRSAEncryption:
            self = .sha1
        default:
            throw CertificateError.unsupportedSignatureAlgorithm(
                reason: "Cannot generate digest algorithm for \(signatureAlgorithm)"
            )
        }
    }
}