Kaladaran/briar
0
0
Fork 0
mirror of https://code.briarproject.org/briar/briar.git synced 2026-02-16 20:59:54 +01:00
Code Issues Projects Releases Wiki Activity

Update javadoc.

Browse Source
This commit is contained in:
akwizgran
2019-05-27 17:54:23 +01:00
parent 44d2526997
commit 819deca93c
1 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
bramble-api/src/main/java/org/briarproject/bramble/api/crypto/CryptoComponent.java
View File

@@ -27,21 +27,25 @@ public interface CryptoComponent {
/** /**
* Derives another secret key from the given secret key. * Derives another secret key from the given secret key.
* *
* @param label a namespaced label indicating the purpose of the derived * @param label A namespaced label indicating the purpose of the derived
* key, to prevent it from being repurposed or colliding with a key derived * key, to prevent it from being repurposed or colliding with a key derived
* for another purpose * for another purpose
* @param inputs Additional inputs that will be included in the derivation
* of the key
*/ */
SecretKey deriveKey(String label, SecretKey k, byte[]... inputs); SecretKey deriveKey(String label, SecretKey k, byte[]... inputs);
/** /**
* Derives a shared secret from two key pairs. * Derives a shared secret from two key pairs.
* *
* @param label a namespaced label indicating the purpose of this shared * @param label A namespaced label indicating the purpose of this shared
* secret, to prevent it from being repurposed or colliding with a shared * secret, to prevent it from being repurposed or colliding with a shared
* secret derived for another purpose * secret derived for another purpose
* @param theirPublicKey the public key of the remote party * @param theirPublicKey The public key of the remote party
* @param ourKeyPair the key pair of the local party * @param ourKeyPair The key pair of the local party
* @return the shared secret * @param inputs Additional inputs that will be included in the derivation
* of the shared secret
* @return The shared secret
*/ */
SecretKey deriveSharedSecret(String label, PublicKey theirPublicKey, SecretKey deriveSharedSecret(String label, PublicKey theirPublicKey,
KeyPair ourKeyPair, byte[]... inputs) KeyPair ourKeyPair, byte[]... inputs)
@@ -50,16 +54,18 @@ public interface CryptoComponent {
/** /**
* Derives a shared secret from two static and two ephemeral key pairs. * Derives a shared secret from two static and two ephemeral key pairs.
* *
* @param label a namespaced label indicating the purpose of this shared * @param label A namespaced label indicating the purpose of this shared
* secret, to prevent it from being repurposed or colliding with a shared * secret, to prevent it from being repurposed or colliding with a shared
* secret derived for another purpose * secret derived for another purpose
* @param theirStaticPublicKey the static public key of the remote party * @param theirStaticPublicKey The static public key of the remote party
* @param theirEphemeralPublicKey the ephemeral public key of the remote * @param theirEphemeralPublicKey The ephemeral public key of the remote
* party * party
* @param ourStaticKeyPair the static key pair of the local party * @param ourStaticKeyPair The static key pair of the local party
* @param ourEphemeralKeyPair the ephemeral key pair of the local party * @param ourEphemeralKeyPair The ephemeral key pair of the local party
* @param alice true if the local party is Alice * @param alice True if the local party is Alice
* @return the shared secret * @param inputs Additional inputs that will be included in the
* derivation of the shared secret
* @return The shared secret
*/ */
SecretKey deriveSharedSecret(String label, PublicKey theirStaticPublicKey, SecretKey deriveSharedSecret(String label, PublicKey theirStaticPublicKey,
PublicKey theirEphemeralPublicKey, KeyPair ourStaticKeyPair, PublicKey theirEphemeralPublicKey, KeyPair ourStaticKeyPair,
@@ -69,7 +75,7 @@ public interface CryptoComponent {
/** /**
* Signs the given byte[] with the given private key. * Signs the given byte[] with the given private key.
* *
* @param label a namespaced label indicating the purpose of this * @param label A namespaced label indicating the purpose of this
* signature, to prevent it from being repurposed or colliding with a * signature, to prevent it from being repurposed or colliding with a
* signature created for another purpose * signature created for another purpose
*/ */
@@ -80,10 +86,10 @@ public interface CryptoComponent {
* Verifies that the given signature is valid for the signed data * Verifies that the given signature is valid for the signed data
* and the given public key. * and the given public key.
* *
* @param label a namespaced label indicating the purpose of this * @param label A namespaced label indicating the purpose of this
* signature, to prevent it from being repurposed or colliding with a * signature, to prevent it from being repurposed or colliding with a
* signature created for another purpose * signature created for another purpose
* @return true if the signature was valid, false otherwise. * @return True if the signature was valid, false otherwise.
*/ */
boolean verifySignature(byte[] signature, String label, byte[] signed, boolean verifySignature(byte[] signature, String label, byte[] signed,
PublicKey publicKey) throws GeneralSecurityException; PublicKey publicKey) throws GeneralSecurityException;
@@ -92,7 +98,7 @@ public interface CryptoComponent {
* Returns the hash of the given inputs. The inputs are unambiguously * Returns the hash of the given inputs. The inputs are unambiguously
* combined by prefixing each input with its length. * combined by prefixing each input with its length.
* *
* @param label a namespaced label indicating the purpose of this hash, to * @param label A namespaced label indicating the purpose of this hash, to
* prevent it from being repurposed or colliding with a hash created for * prevent it from being repurposed or colliding with a hash created for
* another purpose * another purpose
*/ */
@@ -103,7 +109,7 @@ public interface CryptoComponent {
* given inputs. The inputs are unambiguously combined by prefixing each * given inputs. The inputs are unambiguously combined by prefixing each
* input with its length. * input with its length.
* *
* @param label a namespaced label indicating the purpose of this MAC, to * @param label A namespaced label indicating the purpose of this MAC, to
* prevent it from being repurposed or colliding with a MAC created for * prevent it from being repurposed or colliding with a MAC created for
* another purpose * another purpose
*/ */
@@ -113,10 +119,10 @@ public interface CryptoComponent {
* Verifies that the given message authentication code is valid for the * Verifies that the given message authentication code is valid for the
* given secret key and inputs. * given secret key and inputs.
* *
* @param label a namespaced label indicating the purpose of this MAC, to * @param label A namespaced label indicating the purpose of this MAC, to
* prevent it from being repurposed or colliding with a MAC created for * prevent it from being repurposed or colliding with a MAC created for
* another purpose * another purpose
* @return true if the MAC was valid, false otherwise. * @return True if the MAC was valid, false otherwise.
*/ */
boolean verifyMac(byte[] mac, String label, SecretKey macKey, boolean verifyMac(byte[] mac, String label, SecretKey macKey,
byte[]... inputs); byte[]... inputs);