external/secretive
1
0
Fork 0
mirror of https://github.com/maxgoedjen/secretive.git synced 2025-10-31 07:20:57 +00:00
Code Issues Projects Releases Wiki Activity

Docs (#310)

Browse Source
This commit is contained in:
Max Goedjen 2022-01-01 18:45:03 -08:00 committed by GitHub
parent fb6cebe92f
commit eb282b4116
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Sources/Packages/Sources/SmartCardSecretKit/Documentation.docc/Documentation.md Normal file
View File

@ -0,0 +1,3 @@
# ````SmartCardSecretKit````
SmartCardSecretKit contains implementations of SecretKit protocols backed by a Smart Card.

1
Sources/Packages/Sources/SmartCardSecretKit/SmartCard.swift
View File

@ -1 +1,2 @@
/// Namespace for the Smart Card implementations.
public enum SmartCard {}

1
Sources/Packages/Sources/SmartCardSecretKit/SmartCardSecret.swift
View File

@ -4,6 +4,7 @@ import SecretKit
extension SmartCard {
/// An implementation of Secret backed by a Smart Card.
public struct Secret: SecretKit.Secret {
public let id: Data

11
Sources/Packages/Sources/SmartCardSecretKit/SmartCardStore.swift
View File

@ -8,6 +8,7 @@ import SecretKit
// ie, each token has its own Store.
extension SmartCard {
/// An implementation of Store backed by a Smart Card.
public class Store: SecretStore {
@Published public var isAvailable: Bool = false
@ -17,6 +18,7 @@ extension SmartCard {
private let watcher = TKTokenWatcher()
private var tokenID: String?
/// Initializes a Store.
public init() {
tokenID = watcher.nonSecureEnclaveTokens.first
watcher.setInsertionHandler { string in
@ -91,11 +93,14 @@ extension SmartCard {
extension SmartCard.Store {
/// Resets the token ID and reloads secrets.
/// - Parameter tokenID: The ID of the token that was removed.
private func smartcardRemoved(for tokenID: String? = nil) {
self.tokenID = nil
reloadSecrets()
}
/// Reloads all secrets from the store.
private func reloadSecrets() {
DispatchQueue.main.async {
self.isAvailable = self.tokenID != nil
@ -104,6 +109,7 @@ extension SmartCard.Store {
}
}
/// Loads all secrets from the store.
private func loadSecrets() {
guard let tokenID = tokenID else { return }
@ -153,6 +159,7 @@ extension SmartCard.Store {
extension TKTokenWatcher {
/// All available tokens, excluding the Secure Enclave.
fileprivate var nonSecureEnclaveTokens: [String] {
tokenIDs.filter { !$0.contains("setoken") }
}
@ -161,11 +168,15 @@ extension TKTokenWatcher {
extension SmartCard {
/// A wrapper around an error code reported by a Keychain API.
public struct KeychainError: Error {
/// The status code involved.
public let statusCode: OSStatus
}
/// A signing-related error.
public struct SigningError: Error {
/// The underlying error reported by the API, if one was returned.
public let error: SecurityError?
}