File: ExtensionsBuilder.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 (146 lines) | stat: -rw-r--r-- 5,210 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

/// Provides a result-builder style DSL for constructing ``Certificate/Extensions-swift.struct`` values.
///
/// This DSL allows us to construct extensions straightforwardly, using their high-level representation instead of
/// the erased representation provided by ``Certificate/Extension``. For example, a simple set of
/// extensions can be produced like this:
///
/// ```swift
/// let extensions = Certificate.Extensions {
///     Critical(
///         KeyUsage(digitalSignature: true, keyCertSign: true, cRLSign: true)
///     )
///
///     ExtendedKeyUsage([.serverAuth, .clientAuth])
///
///     Critical(
///         BasicConstraints.isCertificateAuthority(maxPathLength: 0)
///     )
///
///     AuthorityInformationAccess([.init(method: .ocspServer, location: .uniformResourceIdentifier("http://ocsp.digicert.com"))])
/// }
/// ```
///
/// Users can extend this syntax for their own extensions by conforming their semantic type to ``CertificateExtensionConvertible``.
/// This is the only requirement for adding new extensions to this builder syntax.
///
/// Users are also able to mark specific extensions as critical by using the ``Critical`` helper type.
@resultBuilder
public struct ExtensionsBuilder {
    @inlinable
    public static func buildExpression<Extension: CertificateExtensionConvertible>(
        _ expression: Extension
    ) -> Result<Certificate.Extensions, any Error> {
        Result {
            try Certificate.Extensions([expression.makeCertificateExtension()])
        }
    }

    @inlinable
    public static func buildExpression(
        _ expression: Certificate.Extensions
    ) -> Result<Certificate.Extensions, any Error> {
        .success(expression)
    }

    @inlinable
    public static func buildExpression() -> Result<Certificate.Extensions, any Error> {
        .success(Certificate.Extensions())
    }

    @inlinable
    public static func buildBlock() -> Result<Certificate.Extensions, any Error> {
        .success(Certificate.Extensions())
    }

    @inlinable
    public static func buildBlock(
        _ components: Result<Certificate.Extensions, any Error>...
    ) -> Result<Certificate.Extensions, any Error> {
        Result {
            try Certificate.Extensions(try components.lazy.flatMap { try $0.get() })
        }
    }

    @inlinable
    public static func buildOptional(
        _ component: Result<Certificate.Extensions, any Error>?
    ) -> Result<Certificate.Extensions, any Error> {
        component ?? .success(Certificate.Extensions())
    }

    @inlinable
    public static func buildEither(
        first component: Result<Certificate.Extensions, any Error>
    ) -> Result<Certificate.Extensions, any Error> {
        component
    }

    @inlinable
    public static func buildEither(
        second component: Result<Certificate.Extensions, any Error>
    ) -> Result<Certificate.Extensions, any Error> {
        component
    }

    @inlinable
    public static func buildArray(
        _ components: [Result<Certificate.Extensions, any Error>]
    ) -> Result<Certificate.Extensions, any Error> {
        Result {
            try Certificate.Extensions(try components.lazy.flatMap { try $0.get() })
        }
    }

    @inlinable
    public static func buildLimitedAvailability(
        _ component: Result<Certificate.Extensions, any Error>
    ) -> Result<Certificate.Extensions, any Error> {
        component
    }
}

/// Conforming types are capable of being erased into ``Certificate/Extension`` values.
///
/// Note that for most extension types, the returned ``Certificate/Extension`` should have its
/// ``Certificate/Extension/critical`` value set to `false`. This allows the ``Critical`` helper
/// type to fulfill its function as expected.
public protocol CertificateExtensionConvertible {
    /// Convert the value into a ``Certificate/Extension``.
    func makeCertificateExtension() throws -> Certificate.Extension
}

/// Marks a given ``CertificateExtensionConvertible`` value as critical.
///
/// This type is used only within the ``ExtensionsBuilder`` DSL to mark extensions as critical.
@frozen
public struct Critical<BaseExtension: CertificateExtensionConvertible>: CertificateExtensionConvertible {
    /// The ``CertificateExtensionConvertible`` backing this value.
    public var base: BaseExtension

    /// Wrap a ``CertificateExtensionConvertible`` value and mark it critical.
    @inlinable
    public init(_ base: BaseExtension) {
        self.base = base
    }

    @inlinable
    public func makeCertificateExtension() throws -> Certificate.Extension {
        var ext = try self.base.makeCertificateExtension()
        ext.critical = true
        return ext
    }
}