KeyknoxClient

@objc(VSSKeyknoxClient)
open class KeyknoxClient : BaseClient

extension KeyknoxClient: KeyknoxClientProtocol

Class representing operations with Virgil Keyknox service

defaultURL
Default URL for service
Declaration
Swift

@objc public static let defaultURL: URL
serviceErrorDomain
Error domain for Error instances thrown from service
Declaration
Swift

override open class var serviceErrorDomain: String { get }


                    
                    
                    init(accessTokenProvider:)

Initializes new KeyknoxClient instance

Declaration

Swift

@objc
public convenience init(accessTokenProvider: AccessTokenProvider)

Parameters


                                accessTokenProvider

Access Token Provider


                    
                    
                    init(accessTokenProvider:serviceUrl:)

Initializes new KeyknoxClient instance

Declaration

Swift

@objc
public convenience init(accessTokenProvider: AccessTokenProvider, serviceUrl: URL)

Parameters

`accessTokenProvider`	Access Token Provider
`serviceUrl`	service URL


                    
                    
                    init(accessTokenProvider:serviceUrl:connection:retryConfig:)

Initializes new KeyknoxClient instance

Declaration

Swift

public init(accessTokenProvider: AccessTokenProvider,
            serviceUrl: URL,
            connection: HttpConnectionProtocol? = nil,
            retryConfig: ExpBackoffRetry.Config)

Parameters

`accessTokenProvider`	Access Token Provider
`serviceUrl`	service URL
`requestRetryConfig`	Retry config

Queries

virgilKeyknoxHashKey
Header key for blob hash
Declaration
Swift

@objc public static let virgilKeyknoxHashKey: String
virgilKeyknoxPreviousHashKey
Header key for previous blob hash
Declaration
Swift

@objc public static let virgilKeyknoxPreviousHashKey: String


                    
                    
                    keyStorageRoot

Default root value

Declaration

Swift

@objc
public static let keyStorageRoot: String


                    
                    
                    keyStoragePath

Default path value

Declaration

Swift

@objc
public static let keyStoragePath: String


                    
                    
                    keyStorageKey

Default key value

Declaration

Swift

@objc
public static let keyStorageKey: String


                    
                    
                    pushValue(params:meta:value:previousHash:)

Push value to Keyknox service

Throws

KeyknoxClientError.emptyIdentities, if identities are empty
KeyknoxClientError.constructingUrl, if url initialization failed
KeyknoxClientError.invalidOptions, if internal options error occured
ServiceError, if service returned correctly-formed error json
NSError with KeyknoxClient.serviceErrorDomain error domain, http status code as error code, and description string if present in http body
Rethrows from ServiceRequest, HttpConnectionProtocol, JsonDecoder, BaseClient

Declaration

Swift

public func pushValue(params: KeyknoxPushParams? = nil,
                      meta: Data,
                      value: Data,
                      previousHash: Data?) throws -> EncryptedKeyknoxValue

Parameters

`params`	params
`meta`	meta data
`value`	encrypted blob
`previousHash`	hash of previous blob

Return Value

EncryptedKeyknoxValue


                    
                    
                    pullValue(params:)

Pulls values from Keyknox service

Throws

KeyknoxClientError.constructingUrl, if url initialization failed
ServiceError, if service returned correctly-formed error json
NSError with KeyknoxClient.serviceErrorDomain error domain, http status code as error code, and description string if present in http body
Rethrows from ServiceRequest, HttpConnectionProtocol, JsonDecoder, BaseClient

Declaration

Swift

public func pullValue(params: KeyknoxPullParams? = nil) throws -> EncryptedKeyknoxValue

Parameters


                                params

Pull params

Return Value

EncryptedKeyknoxValue


                    
                    
                    getKeys(params:)

Get keys for given root

Throws

KeyknoxClientError.constructingUrl, if url initialization failed
ServiceError, if service returned correctly-formed error json
NSError with KeyknoxClient.serviceErrorDomain error domain, http status code as error code, and description string if present in http body
Rethrows from ServiceRequest, HttpConnectionProtocol, JsonDecoder, BaseClient

Declaration

Swift

public func getKeys(params: KeyknoxGetKeysParams) throws -> Set<String>

Parameters


                                params

Get keys params

Return Value

Array of keys


                    
                    
                    resetValue(params:)

Resets Keyknox value (makes it empty)

Throws

KeyknoxClientError.constructingUrl, if url initialization failed
ServiceError, if service returned correctly-formed error json
NSError with KeyknoxClient.serviceErrorDomain error domain, http status code as error code, and description string if present in http body
Rethrows from ServiceRequest, HttpConnectionProtocol, JsonDecoder, BaseClient

Declaration

Swift

open func resetValue(params: KeyknoxResetParams? = nil) throws -> DecryptedKeyknoxValue

Parameters


                                params

Reset params

Return Value

DecryptedKeyknoxValue


                    
                    
                    deleteRecipient(params:)

Deletes recipient

Throws

KeyknoxClientError.constructingUrl, if url initialization failed
ServiceError, if service returned correctly-formed error json
NSError with KeyknoxClient.serviceErrorDomain error domain, http status code as error code, and description string if present in http body
Rethrows from ServiceRequest, HttpConnectionProtocol, JsonDecoder, BaseClient

Declaration

Swift

open func deleteRecipient(params: KeyknoxDeleteRecipientParams) throws -> DecryptedKeyknoxValue

Parameters


                                params

Delete recipient params

Return Value

DecryptedKeyknoxValue