File: KEM.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 (58 lines) | stat: -rw-r--r-- 1,959 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftCrypto open source project
//
// Copyright (c) 2019-2020 Apple Inc. and the SwiftCrypto project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.md for the list of SwiftCrypto project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
#if CRYPTO_IN_SWIFTPM && !CRYPTO_IN_SWIFTPM_FORCE_BUILD_API
@_exported import CryptoKit
#else
import Foundation

/// A Key Encapsulation Mechanism
public enum KEM {
    /// The result of an encapsulation operation
    public struct EncapsulationResult {
        /// The shared secret
        public let sharedSecret: SymmetricKey
        /// The encapsulated secret
        public let encapsulated: Data
        
        public init(sharedSecret: SymmetricKey, encapsulated: Data) {
            self.sharedSecret = sharedSecret
            self.encapsulated = encapsulated
        }
    }
}

/// A Key Encapsulation Mechanism's Public Key
public protocol KEMPublicKey {
    /// Encapsulates the generated shared secret
    /// - Returns: The shared secret and its encapsulated version
    func encapsulate() throws -> KEM.EncapsulationResult
}

/// A Key Encapsulation Mechanism's Private Key
public protocol KEMPrivateKey {
    associatedtype PublicKey: KEMPublicKey
    
    /// Generate a new random Private Key
    /// - Returns: The generated private key
    static func generate() throws -> Self
    
    /// Decapsulates the encapsulated shared secret
    /// - Parameter encapsulated: The encapsulated shared secret
    /// - Returns: The decapsulated shared secret
    func decapsulate(_ encapsulated: Data) throws -> SymmetricKey
    
    /// Returns the associated public key
    var publicKey: PublicKey { get }
}
#endif // Linux or !SwiftPM