blob: aa71abf60a4f15be27c39aaab727f8502688a5d3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
/*
* Copyright © 2014-2021 The Android Password Store Authors. All Rights Reserved.
* SPDX-License-Identifier: GPL-3.0-only
*/
package dev.msfjarvis.aps.crypto
import com.github.michaelbull.result.Result
/**
* [KeyManager] defines a contract for implementing a management system for [Key]s as they would be
* used by an implementation of [CryptoHandler] to obtain eligible public or private keys as
* required.
*/
public interface KeyManager<Key, KeyIdentifier> {
/**
* Inserts a [key] into the store. If the key already exists, this method will return
* [KeyManagerException.KeyAlreadyExistsException] unless [replace] is `true`.
*/
public suspend fun addKey(key: Key, replace: Boolean = false): Result<Key, Throwable>
/** Removes [key] from the store. */
public suspend fun removeKey(key: Key): Result<Key, Throwable>
/**
* Get a [Key] for the given [id]. The actual semantics of what [id] is are left to individual
* implementations to figure out for themselves. For example, in GPG this can be a full
* hexadecimal key ID, an email, a short hex key ID, and probably a few more things.
*/
public suspend fun getKeyById(id: KeyIdentifier): Result<Key, Throwable>
/** Returns all keys currently in the store as a [List]. */
public suspend fun getAllKeys(): Result<List<Key>, Throwable>
/**
* Get a stable identifier for the given [key]. The returned key ID should be suitable to be used
* as an identifier for the cryptographic identity tied to this key.
*/
public suspend fun getKeyId(key: Key): KeyIdentifier?
/** Given a [fileName], return whether this instance can handle it. */
public fun canHandle(fileName: String): Boolean
}
|
