File: Cipher.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 (68 lines) | stat: -rw-r--r-- 2,855 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
//===----------------------------------------------------------------------===//
//
// 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

protocol AEADSealedBox {
    associatedtype Nonce: Sequence
    /// The authentication tag
    var tag: Data { get }
    /// The ciphertext
    var ciphertext: Data { get }
    /// The Nonce
    var nonce: Nonce { get }

    /// Initializes a SealedBox from a tag and ciphertext data. May fail if the authentication tag is not expected size.
    ///
    /// - Parameters:
    ///   - nonce: The nonce.
    ///   - tag: The authentication tag
    ///   - ciphertext: The ciphertext
    init<C: DataProtocol, T: DataProtocol>(nonce: Nonce, ciphertext: C, tag: T) throws
}

/// A type representing authenticated encryption with associated data.
protocol Cipher {
    associatedtype Key
    associatedtype SealedBox: AEADSealedBox
    associatedtype Nonce: Sequence

    /// Seals the box. This encrypts and authenticates the message. Optionally, additional data can also be authenticated.
    ///
    /// - Parameters:
    ///   - key: The key used to seal.
    ///   - message: The message to seal.
    ///   - nonce: A Nonce used for sealing.
    ///   - authenticatedData: Optional additional data to be authenticated.
    /// - Returns: The sealed box containing the ciphertext and authentication tag
    /// - Throws: An error occurred while encrypting or authenticating.
    static func seal<Plaintext: DataProtocol, AuthenticatedData: DataProtocol>
        (_ message: Plaintext, using key: SymmetricKey, nonce: Nonce?, authenticating: AuthenticatedData) throws -> SealedBox

    /// Opens the sealed box. This decrypts and verifies the authenticity of the message,
    /// and optionally verifies the authenticity of the authenticated data.
    ///
    /// - Parameters:
    ///   - key: The key used to seal.
    ///   - sealedBox: The sealed box to open
    ///   - nonce: The nonce used for sealing
    ///   - authenticatedData: The data that was authenticated.
    /// - Returns: Returns the data, if the correct key is used and the authenticated data matches the one from the seal operation.
    /// - Throws: An error occurred while decrypting or authenticating.
    static func open<AuthenticatedData: DataProtocol>
        (_ sealedBox: SealedBox, using key: Key, authenticating: AuthenticatedData) throws -> Data
}
#endif