SPB Git

Repository Public

SecretTests.swift 14.1 KB 270 lines swift

1// =============================================================================2//                  SP BOUCHER | SOFTWARE & RESEARCH3//             ARTIFICIAL INTELLIGENCE • FINANCE • ENGINEERING4// =============================================================================5//6// PROJECT METADATA7// -----------------------------------------------------------------------------8// Project          : SP Term9// File             : Packages/SPIntelligence/Tests/AIAssistantTests/SecretTests.swift10// Module           : AIAssistantTests11// Repository       : https://git.spboucher.ai/sp-term12// Created          : 2026-11-1713// Last Modified    : 2026-11-1714//15// =============================================================================16// AUTHOR & PROFESSIONAL AFFILIATION17// =============================================================================18//19// Author           : Simon-Pierre Boucher20// Position         : Professor of Finance21// Institution      : Université du Québec en Outaouais (UQO)22// Department       : Département des sciences administratives23// Organization     : SP Boucher24//25// Website          : https://spboucher.ai26// Git              : https://git.spboucher.ai27//28// =============================================================================29// OFFICIAL CONTACT DIRECTORY30// =============================================================================31//32// General          : info@spboucher.ai33// Professional     : contact@spboucher.ai34// Direct           : simon@spboucher.ai35// Research         : research@spboucher.ai36// Development      : dev@spboucher.ai37// Support          : support@spboucher.ai38// Security/Admin   : admin@spboucher.ai39// Notifications    : notifications@spboucher.ai40//41// Preferred Contact: support@spboucher.ai42//43// =============================================================================44// COPYRIGHT & INTELLECTUAL PROPERTY45// =============================================================================46//47// Copyright (c) 202648// Simon-Pierre Boucher49//50// All rights reserved where applicable.51//52// This file is governed by the applicable project license,53// copyright notices, institutional agreements and relevant law.54//55// Unless expressly authorized by the applicable license or56// rights holder, copying, redistribution, sublicensing,57// publication and commercial exploitation are not permitted.58//59// Existing third-party rights and notices remain unaffected.60//61// =============================================================================62// CONFIDENTIALITY & SECURITY63// =============================================================================64//65// Classification   : Public66// Distribution     : Public repository; use is governed by the project license67// Security Contact : admin@spboucher.ai68//69// Access to this source does not independently grant permission70// to redistribute or disclose confidential materials.71//72// Do not embed credentials, private keys, access tokens,73// certificates or confidential personal information.74//75// =============================================================================76// LICENSE & MAINTENANCE77// =============================================================================78//79// License          : None specified (no license file in this repository)80// Maintainer       : Simon-Pierre Boucher81// Technical Contact: dev@spboucher.ai82//83// =============================================================================84// END OF SP BOUCHER SOURCE HEADER85// =============================================================================8687import Foundation88import Testing89import AIAssistant9091// All values below are fabricated and shaped only to exercise the patterns.92private let fakeAnthropic = "sk-ant-" + "api03-FAKEfakeFAKEfake1234567890abcdEFGH"93private let fakeOpenAI = "sk-" + "proj-FAKEfakeFAKEfake1234567890abcd"94private let fakeAWSID = "AKIA" + "FAKEFAKEFAKE1234"95private let fakeAWSSecret = "wJalrFAKEFAKEK7MDENG/bPxRfiCYFAKEFAKEKEY"96private let fakeJWT = "eyJhbGciOiJIUzI1NiJ9" + ".eyJzdWIiOiIxMjM0NTY3ODkwIn0" + ".SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV"97private let fakePEM = """98    -----BEGIN OPENSSH PRIVATE KEY-----99    b3BlbnNzaC1rZXktdjEAAAAABG5vbmUFAKEFAKEFAKE100    QyNTUxOQAAACDFAKEFAKEFAKEFAKEFAKE101    -----END OPENSSH PRIVATE KEY-----102    """103104struct RedactionCase: Sendable, CustomTestStringConvertible {105    let name: String106    let input: String107    let kind: SecretKind108    let secrets: [String]109    var testDescription: String { name }110}111112private let redactionCases: [RedactionCase] = [113    .init(name: "anthropic key", input: "key is \(fakeAnthropic) ok", kind: .anthropicAPIKey, secrets: [fakeAnthropic]),114    .init(name: "openai key", input: "OPENAI=\(fakeOpenAI)", kind: .openAIAPIKey, secrets: [fakeOpenAI]),115    .init(name: "x-api-key header", input: "curl -H 'x-api-key: \(fakeAnthropic)' https://api.anthropic.com", kind: .anthropicAPIKey, secrets: [fakeAnthropic]),116    .init(name: "aws access key id", input: "aws id \(fakeAWSID) here", kind: .awsAccessKeyID, secrets: [fakeAWSID]),117    .init(name: "aws secret assignment", input: "aws_secret_access_key = \(fakeAWSSecret)", kind: .awsSecretKey, secrets: [fakeAWSSecret]),118    .init(name: "aws secret env", input: "export AWS_SECRET_ACCESS_KEY=\"\(fakeAWSSecret)\"", kind: .awsSecretKey, secrets: [fakeAWSSecret]),119    .init(name: "github ghp", input: "token ghp_" + "FAKEfake1234567890FAKEfake1234567890", kind: .githubToken, secrets: ["FAKEfake1234567890FAKEfake1234567890"]),120    .init(name: "github gho", input: "gho_" + "FAKEfake1234567890FAKEfake1234567890 pushed", kind: .githubToken, secrets: ["FAKEfake1234567890FAKEfake1234567890"]),121    .init(name: "github fine-grained", input: "use github_pat_" + "11FAKEFAKE0abcdefghij_FAKEfake1234567890", kind: .githubToken, secrets: ["11FAKEFAKE0abcdefghij_FAKEfake1234567890"]),122    .init(name: "slack bot token", input: "SLACK xoxb-" + "123456789012-FAKEfakeFAKEfake", kind: .slackToken, secrets: ["123456789012-FAKEfakeFAKEfake"]),123    .init(name: "jwt", input: "session \(fakeJWT) end", kind: .jsonWebToken, secrets: [fakeJWT, "SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV"]),124    .init(name: "pem block", input: "before\n\(fakePEM)\nafter", kind: .privateKeyBlock, secrets: ["b3BlbnNzaC1rZXktdjEAAAAABG5vbmUFAKEFAKEFAKE", "QyNTUxOQAAACDFAKE"]),125    .init(name: "unterminated pem block", input: "-----BEGIN RSA PRIVATE KEY-----\nMIIEFAKEFAKEFAKEFAKE\nmoreFAKEdata", kind: .privateKeyBlock, secrets: ["MIIEFAKEFAKEFAKEFAKE", "moreFAKEdata"]),126    .init(name: "bearer header", input: "Authorization: Bearer abcFAKE123.def-456_ghi", kind: .authorizationHeader, secrets: ["abcFAKE123.def-456_ghi"]),127    .init(name: "basic header", input: "curl -H \"Authorization: Basic dXNlcjpGQUtFcGFzcw==\" https://x", kind: .authorizationHeader, secrets: ["dXNlcjpGQUtFcGFzcw=="]),128    .init(name: "bare bearer", input: "sent bearer FAKEfakeFAKEfake1234567890 to server", kind: .authorizationHeader, secrets: ["FAKEfakeFAKEfake1234567890"]),129    .init(name: "curl -u", input: "curl -u admin:hunter2FAKE https://x", kind: .authorizationHeader, secrets: ["hunter2FAKE"]),130    .init(name: "url credentials", input: "git clone https://deploy:s3cretFAKEpw@git.example.com/repo.git", kind: .urlCredentials, secrets: ["s3cretFAKEpw", "deploy:"]),131    .init(name: "postgres url", input: "DATABASE_URL=postgres://app:pgFAKEpass@db.internal:5432/app", kind: .urlCredentials, secrets: ["pgFAKEpass"]),132    .init(name: "password assignment", input: "password = hunter2FAKE", kind: .genericAssignment, secrets: ["hunter2FAKE"]),133    .init(name: "passwd colon", input: "passwd: \"my FAKE pass phrase\"", kind: .genericAssignment, secrets: ["my FAKE pass phrase"]),134    .init(name: "secret yaml", input: "client_secret: abcFAKE123", kind: .genericAssignment, secrets: ["abcFAKE123"]),135    .init(name: "token json", input: "{\"token\": \"tokFAKEvalue\", \"n\": 1}", kind: .genericAssignment, secrets: ["tokFAKEvalue"]),136    .init(name: "api_key assignment", input: "api_key=abcFAKE123456", kind: .genericAssignment, secrets: ["abcFAKE123456"]),137    .init(name: "export token", input: "export FOO_TOKEN=abcFAKE123456", kind: .genericAssignment, secrets: ["abcFAKE123456"]),138    .init(name: "export quoted", input: "export DB_PASSWORD='p@ss FAKE w0rd'", kind: .genericAssignment, secrets: ["p@ss FAKE w0rd"]),139    .init(name: "cli flag", input: "mysql --password hunter2FAKE -h db", kind: .genericAssignment, secrets: ["hunter2FAKE"]),140    .init(name: "query string", input: "GET /cb?access_token=abcFAKE123&x=1", kind: .genericAssignment, secrets: ["abcFAKE123"]),141]142143@Suite struct SecretRedactorTests {144    @Test(arguments: redactionCases)145    func redactsEachKind(_ c: RedactionCase) {146        let result = SecretRedactor().redact(c.input)147        #expect(result.findings.contains { $0.kind == c.kind && $0.count >= 1 }, "findings: \(result.findings)")148        for secret in c.secrets {149            #expect(!result.text.contains(secret), "leaked in text: \(result.text)")150            #expect(!String(describing: result.findings).contains(secret))151            #expect(!String(reflecting: result).contains(secret))152        }153        #expect(result.text.contains("[REDACTED:"))154    }155156    @Test func leavesOrdinaryTextAlone() {157        let text = "ls -la /tmp\nmax_tokens: 4096\nerror: file not found at src/main.swift:12\ngit commit -m 'fix tokenizer'"158        let result = SecretRedactor().redact(text)159        #expect(result.text == text)160        #expect(result.findings.isEmpty)161        #expect(result.totalCount == 0)162    }163164    @Test func countsAndKeepsContext() {165        let result = SecretRedactor().redact("a=\(fakeAnthropic)\nb=\(fakeAnthropic)x\nurl https://u:pFAKEw@h/x")166        #expect(result.findings.first { $0.kind == .anthropicAPIKey }?.count == 2)167        #expect(result.text.contains("https://[REDACTED:url-credentials]@h/x"))168        #expect(result.totalCount == 3)169    }170171    @Test func eachSecretCountedOnce() {172        let result = SecretRedactor().redact("Authorization: Bearer \(fakeAnthropic)\nexport AWS_SECRET_ACCESS_KEY=\(fakeAWSSecret)")173        #expect(result.findings == [174            RedactionFinding(kind: .authorizationHeader, count: 1),175            RedactionFinding(kind: .awsSecretKey, count: 1),176        ])177    }178179    @Test func masksKnownLiterals() {180        let redactor = SecretRedactor(additionalSecrets: [SecretValue("correct horse battery")])181        let result = redactor.redact("the phrase correct horse battery appears")182        #expect(result.text == "the phrase [REDACTED:known-secret] appears")183        #expect(result.findings == [RedactionFinding(kind: .knownSecret, count: 1)])184    }185186    @Test func idempotent() {187        let once = SecretRedactor().redact(redactionCases.map(\.input).joined(separator: "\n"))188        let twice = SecretRedactor().redact(once.text)189        #expect(twice.text == once.text)190        #expect(twice.findings.isEmpty)191    }192}193194@Suite struct SecretValueTests {195    @Test func neverPrintsItself() {196        let raw = "sk-ant-FAKE-super-secret-value"197        let secret = SecretValue(raw)198        struct Holder { let key: SecretValue; let label: String }199        let holder = Holder(key: secret, label: "x")200        var dumped = ""201        dump(holder, to: &dumped)202        for text in ["\(secret)", String(describing: secret), String(reflecting: secret), "\(holder)", String(reflecting: holder), dumped, "\([secret])", "\(Optional(secret) as Any)"] {203            #expect(!text.contains(raw), "leak: \(text)")204            #expect(!text.contains("super-secret"))205        }206        #expect(secret.reveal() == raw)207    }208209    @Test func inMemoryStoreRoundTrip() throws {210        let store = InMemorySecretStore()211        #expect(try store.hasSecret(for: "p1") == false)212        #expect(try store.secret(for: "p1") == nil)213        try store.setSecret(SecretValue("one"), for: "p1")214        try store.setSecret(SecretValue("two"), for: "p1")215        #expect(try store.hasSecret(for: "p1"))216        #expect(try store.secret(for: "p1")?.reveal() == "two")217        #expect(try store.secret(for: "p2") == nil)218        try store.deleteSecret(for: "p1")219        try store.deleteSecret(for: "p1")220        #expect(try store.hasSecret(for: "p1") == false)221    }222223    @Test func storeErrorsCarryNoSecret() {224        #expect(String(describing: SecretStoreError.keychain(status: -25308)) == "Keychain error (OSStatus -25308)")225    }226}227228/// Probes once whether the keychain accepts non-interactive access from this process.229enum KeychainProbe {230    static let available: Bool = {231        let store = KeychainSecretStore(service: "ai.spboucher.spterm.tests.probe.\(UUID().uuidString)")232        defer { try? store.deleteSecret(for: "probe") }233        do {234            try store.setSecret(SecretValue("probe"), for: "probe")235            return try store.secret(for: "probe")?.reveal() == "probe"236        } catch {237            return false238        }239    }()240}241242@Suite struct KeychainSecretStoreTests {243    @Test func defaultServiceName() {244        #expect(KeychainSecretStore().service == "ai.spboucher.spterm.ai")245        #expect(KeychainSecretStore.defaultService == "ai.spboucher.spterm.ai")246    }247248    @Test(.enabled(if: KeychainProbe.available, "keychain refuses non-interactive access"))249    func roundTripInThrowawayService() throws {250        let service = "ai.spboucher.spterm.tests.\(UUID().uuidString)"251        let store = KeychainSecretStore(service: service)252        let account = "provider-\(UUID().uuidString)"253        defer { try? store.deleteSecret(for: account) }254255        #expect(try store.hasSecret(for: account) == false)256        #expect(try store.secret(for: account) == nil)257        try store.setSecret(SecretValue("first-FAKE"), for: account)258        #expect(try store.hasSecret(for: account))259        #expect(try store.secret(for: account)?.reveal() == "first-FAKE")260        try store.setSecret(SecretValue("second-FAKE"), for: account)261        #expect(try store.secret(for: account)?.reveal() == "second-FAKE")262        // Another service does not see it.263        #expect(try KeychainSecretStore(service: service + ".other").secret(for: account) == nil)264        try store.deleteSecret(for: account)265        #expect(try store.hasSecret(for: account) == false)266        #expect(try store.secret(for: account) == nil)267        try store.deleteSecret(for: account) // deleting twice is fine268    }269}270
Files main
Menu

Theme