TheArchive/session-android
1
0
Fork 0
mirror of https://github.com/oxen-io/session-android.git synced 2025-02-20 00:08:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update SessionCipher javadocs.

Browse Source
This commit is contained in:
Moxie Marlinspike 2014-07-20 15:22:50 -07:00
parent 819982af7b
commit b3cece27d6
1 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
libaxolotl/src/main/java/org/whispersystems/libaxolotl/SessionCipher.java
View File

@ -124,6 +124,21 @@ public class SessionCipher {
} }
} }
/**
* Decrypt a message.
*
* @param ciphertext The {@link PreKeyWhisperMessage} to decrypt.
* @return The plaintext.
* @throws InvalidMessageException if the input is not valid ciphertext.
* @throws DuplicateMessageException if the input is a message that has already been received.
* @throws LegacyMessageException if the input is a message formatted by a protocol version that
* is no longer supported.
* @throws InvalidKeyIdException when there is no local {@link org.whispersystems.libaxolotl.state.PreKeyRecord}
* that corresponds to the PreKey ID in the message.
* @throws InvalidKeyException when the message is formatted incorrectly.
* @throws UntrustedIdentityException when the {@link IdentityKey} of the sender is untrusted.
*/
public byte[] decrypt(PreKeyWhisperMessage ciphertext) public byte[] decrypt(PreKeyWhisperMessage ciphertext)
throws DuplicateMessageException, LegacyMessageException, InvalidMessageException, throws DuplicateMessageException, LegacyMessageException, InvalidMessageException,
InvalidKeyIdException, InvalidKeyException, UntrustedIdentityException, NoSessionException InvalidKeyIdException, InvalidKeyException, UntrustedIdentityException, NoSessionException
@ -147,16 +162,18 @@ public class SessionCipher {
/** /**
* Decrypt a message. * Decrypt a message.
* *
* @param ciphertext The ciphertext message bytes corresponding to a serialized * @param ciphertext The {@link WhisperMessage} to decrypt.
* {@link WhisperMessage}. *
* @return The plaintext. * @return The plaintext.
* @throws InvalidMessageException if the input is not valid ciphertext. * @throws InvalidMessageException if the input is not valid ciphertext.
* @throws DuplicateMessageException if the input is a message that has already been received. * @throws DuplicateMessageException if the input is a message that has already been received.
* @throws LegacyMessageException if the input is a message formatted by a protocol version that * @throws LegacyMessageException if the input is a message formatted by a protocol version that
* is no longer supported. * is no longer supported.
* @throws NoSessionException if there is no established session for this contact.
*/ */
public byte[] decrypt(WhisperMessage ciphertext) public byte[] decrypt(WhisperMessage ciphertext)
throws InvalidMessageException, DuplicateMessageException, LegacyMessageException, NoSessionException throws InvalidMessageException, DuplicateMessageException, LegacyMessageException,
NoSessionException
{ {
synchronized (SESSION_LOCK) { synchronized (SESSION_LOCK) {