Skip to content

Commit 76e0568

Browse files
committed
Update docs
1 parent ce2e513 commit 76e0568

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

src/main/java/org/cryptomator/integrations/keychain/KeychainAccessProvider.java

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ static Stream<KeychainAccessProvider> get() {
3333

3434
/**
3535
* Associates a passphrase with a given key.
36+
* <p>
37+
* Note: Caller is responsible for zeroing the passphrase array after use.
3638
*
3739
* @param key Key used to retrieve the passphrase via {@link #loadPassphrase(String)}.
3840
* @param passphrase The secret to store in this keychain.
@@ -47,6 +49,8 @@ default void storePassphrase(String key, CharSequence passphrase) throws Keychai
4749

4850
/**
4951
* Associates a passphrase with a given key and a name for that key.
52+
* <p>
53+
* Note: Caller is responsible for zeroing the passphrase array after use.
5054
*
5155
* @param key Key used to retrieve the passphrase via {@link #loadPassphrase(String)}.
5256
* @param displayName The according name to the key. That's the name of the vault displayed in the UI.
@@ -62,12 +66,14 @@ default void storePassphrase(String key, @Nullable String displayName, CharSeque
6266

6367
/**
6468
* Associates a passphrase with a given key and a name for that key.
69+
* <p>
70+
* Note: Caller is responsible for zeroing the passphrase array after use.
6571
*
66-
* @param key Key used to retrieve the passphrase via {@link #loadPassphrase(String)}.
67-
* @param displayName The according name to the key. That's the name of the vault displayed in the UI.
68-
* It's passed to the keychain as an additional information about the vault besides the key.
69-
* The parameter does not need to be unique or be checked by the keychain.
70-
* @param passphrase The secret to store in this keychain.
72+
* @param key Key used to retrieve the passphrase via {@link #loadPassphrase(String)}.
73+
* @param displayName The according name to the key. That's the name of the vault displayed in the UI.
74+
* It's passed to the keychain as an additional information about the vault besides the key.
75+
* The parameter does not need to be unique or be checked by the keychain.
76+
* @param passphrase The secret to store in this keychain.
7177
* @param requireOsAuthentication Defines, whether the user needs to authenticate to store a passphrase.
7278
* The authentication mechanism is provided by the operating system dependent
7379
* implementations of this API.
@@ -93,6 +99,8 @@ default void storePassphrase(String key, @Nullable String displayName, CharSeque
9399

94100
/**
95101
* Updates a passphrase with a given key. Noop, if there is no item for the given key.
102+
* <p>
103+
* Note: Caller is responsible for zeroing the passphrase array after use.
96104
*
97105
* @param key Unique key previously used while {@link #storePassphrase(String, String, CharSequence)} storing a passphrase}.
98106
* @param passphrase The secret to be updated in this keychain.
@@ -107,6 +115,8 @@ default void changePassphrase(String key, CharSequence passphrase) throws Keycha
107115

108116
/**
109117
* Updates a passphrase with a given key and stores a name for that key. Noop, if there is no item for the given key.
118+
* <p>
119+
* Note: Caller is responsible for zeroing the passphrase array after use.
110120
*
111121
* @param key Unique key previously used while {@link #storePassphrase(String, String, CharSequence)} storing a passphrase}.
112122
* @param displayName The according name to the key. That's the name of the vault displayed in the UI.

0 commit comments

Comments
 (0)