Files
container/Sources/ContainerizationOCI/Client/Authentication.swift
T
Danny Canter 6bc4bf5124 Source code documentation updates (#9)
This change adds documentation to quite a few existing public types that
didn't have a blurb before.

Additionally, this fixes a couple things that I think either didn't make
sense when going to document them:
- Rename ConnectionStream to VsockConnectionStream. This type only
functions for vsock connections.
- Deletes NsLock+Closure. This was not used anywhere.
- Rename ContainerizationOCI/Config.swift to ImageConfig.swift.

Signed-off-by: Danny Canter <danny_canter@apple.com>
2025-06-05 16:16:18 -07:00

48 lines
1.8 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2025 Apple Inc. and the containerization project authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//===----------------------------------------------------------------------===//
import Foundation
/// Abstraction for returning a token needed for logging into an OCI compliant registry.
public protocol Authentication: Sendable {
func token() async throws -> String
}
/// Type representing authentication information for client to access the registry.
public struct BasicAuthentication: Authentication {
/// The username for the authentication.
let username: String
/// The password or identity token for the user.
let password: String
public init(username: String, password: String) {
self.username = username
self.password = password
}
public func token() async throws -> String {
let credentials = "\(username):\(password)"
if let authenticationData = credentials.data(using: .utf8)?.base64EncodedString() {
return "Basic \(authenticationData)"
}
throw Error.invalidCredentials
}
public enum Error: Swift.Error {
case invalidCredentials
}
}