KeychainStorage Class Reference


                    
                    
                    commentStringPrefix

Comment for all macOS password entries created by this class. Used for filtering

Declaration

Swift

@objc
public static let commentStringPrefix: String


                    
                    
                    commentString()

Comment string

Declaration

Swift

@objc
public func commentString() -> String

Return Value

Comment string for macOS Keychain entries


                    
                    
                    createAccess(forName:queryOptions:)

Created access for trusted application + current application

Throws

KeychainStorageError

Declaration

Swift

@objc
public func createAccess(forName name: String, queryOptions: KeychainQueryOptions) throws -> SecAccess

Parameters


                                name

entry name

Return Value

SecAccess


                    
                    
                    createAccessControl()

Undocumented

Declaration

Swift

@objc
public func createAccessControl() throws -> SecAccessControl


                    
                    
                    privateKeyIdentifierFormat

Private key identifier format

Declaration

Swift

@objc
public static let privateKeyIdentifierFormat: String


                    
                    
                    storageParams

KeychainStorage parameters

Declaration

Swift

@objc
public let storageParams: KeychainStorageParams


                    
                    
                    init(storageParams:)

Initializer

Declaration

Swift

@objc
public init(storageParams: KeychainStorageParams)

Parameters


                                storageParams

KeychainStorage parameters


                    
                    
                    store(data:withName:meta:queryOptions:)

Stores sensitive data to Keychain

Throws

KeychainStorageError

Declaration

Swift

@objc
open func store(data: Data,
                withName name: String,
                meta: [String: String]?,
                queryOptions: KeychainQueryOptions?) throws -> KeychainEntry

Parameters

`data`	Sensitive data
`name`	Alias for data
`meta`	Additional meta info

Return Value

Stored entry


                    
                    
                    updateEntry(withName:data:meta:queryOptions:)

Updated entry in Keychain

Throws

KeychainStorageError

Declaration

Swift

@objc
open func updateEntry(withName name: String,
                      data: Data,
                      meta: [String: String]?,
                      queryOptions: KeychainQueryOptions?) throws

Parameters

`name`	Alias
`data`	New data
`meta`	New meta info


                    
                    
                    retrieveEntry(withName:queryOptions:)

Retrieves entry from keychain

Throws

KeychainStorageError

Declaration

Swift

@objc
open func retrieveEntry(withName name: String, queryOptions: KeychainQueryOptions?) throws -> KeychainEntry

Parameters


                                name

Alias

Return Value

Retrieved entry


                    
                    
                    retrieveAllEntries(queryOptions:)

Retrieves all entries in Keychain

Throws

KeychainStorageError

Declaration

Swift

@objc
open func retrieveAllEntries(queryOptions: KeychainQueryOptions?) throws -> [KeychainEntry]

Return Value

Retrieved entries


                    
                    
                    deleteEntry(withName:queryOptions:)

Deletes entry from Keychain

Throws

KeychainStorageError

Declaration

Swift

@objc
open func deleteEntry(withName name: String, queryOptions: KeychainQueryOptions?) throws

Parameters


                                name

Alias


                    
                    
                    deleteAllEntries(queryOptions:)

Deletes all entries from Keychain

Throws

KeychainStorageError

Declaration

Swift

@objc
open func deleteAllEntries(queryOptions: KeychainQueryOptions? = nil) throws


                    
                    
                    existsEntry(withName:queryOptions:)

Checks if entry exists in Keychain

Throws

KeychainStorageError

Declaration

Swift

public func existsEntry(withName name: String, queryOptions: KeychainQueryOptions?) throws -> Bool

Parameters


                                name

Alias

Return Value

true if entry exists, false otherwise


                    
                    
                    retrieveAllEntries()

Declaration

Swift

public func retrieveAllEntries() throws -> [KeychainEntry]


                    
                    
                    deleteEntry(withName:)

Declaration

Swift

public func deleteEntry(withName name: String) throws


                    
                    
                    existsEntry(withName:)

Declaration

Swift

public func existsEntry(withName name: String) throws -> Bool


                    
                    
                    retrieveEntry(withName:)

Declaration

Swift

public func retrieveEntry(withName name: String) throws -> KeychainEntry


                    
                    
                    updateEntry(withName:data:meta:)

Declaration

Swift

public func updateEntry(withName name: String, data: Data, meta: [String : String]?) throws


                    
                    
                    store(data:withName:meta:)

Declaration

Swift

public func store(data: Data, withName name: String, meta: [String : String]?) throws -> KeychainEntry