Index (Vodozemac Java binding 1.0.0 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Account - Class in io.github.fherbreteau.vodozemac.account: An Olm Account manages all cryptographic keys used on a device.
Account() - Constructor for class io.github.fherbreteau.vodozemac.account.Account: Creates a new Account with new random identity keys.
advanceTo(int) - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Permanently advances the session to the specified message index.
asBytes() - Method in class io.github.fherbreteau.vodozemac.ecies.CheckCode: Returns the raw bytes of the check code.

B

base64Decode(String) - Static method in class io.github.fherbreteau.vodozemac.Vodozemac: Decodes a base64 string to raw bytes.
base64Encode(byte[]) - Static method in class io.github.fherbreteau.vodozemac.Vodozemac: Encodes the given bytes to a base64 string without padding.
baseKey() - Method in class io.github.fherbreteau.vodozemac.olm.SessionKeys: Returns the ephemeral Curve25519 public key created by the session initiator to establish the session.
BETTER - Enum constant in enum class io.github.fherbreteau.vodozemac.megolm.SessionOrdering: The first session has a better (lower) initial message index than the second one.
body() - Method in class io.github.fherbreteau.vodozemac.olm.OlmMessage: Returns the base64-encoded ciphertext body of this message.
bytes() - Method in class io.github.fherbreteau.vodozemac.sas.SasBytes: Returns the raw 6 bytes of the short authentication string that are converted into the emoji and decimal representations.
bytes(String) - Method in class io.github.fherbreteau.vodozemac.sas.EstablishedSas: Generates SasBytes using HKDF with the shared secret as the input key material.
bytesRaw(String, int) - Method in class io.github.fherbreteau.vodozemac.sas.EstablishedSas: Generates the given number of bytes using HKDF with the shared secret as the input key material.

C

calculateMac(String, String) - Method in class io.github.fherbreteau.vodozemac.sas.EstablishedSas: Calculates a MAC for the given input using the info string as additional data.
calculateMacInvalidBase64(String, String) - Method in class io.github.fherbreteau.vodozemac.sas.EstablishedSas: Calculates a MAC for the given input using the info string as additional data, returning the MAC as an invalid base64-encoded string.
checkCode() - Method in class io.github.fherbreteau.vodozemac.ecies.EstablishedEcies: Returns the CheckCode which uniquely identifies this ECIES session.
CheckCode - Class in io.github.fherbreteau.vodozemac.ecies: A check code that can be used to confirm that two EstablishedEcies objects share the same secret.
checkNotClosed() - Method in class io.github.fherbreteau.vodozemac.NativeHandle
ciphertext() - Method in class io.github.fherbreteau.vodozemac.account.DehydratedDeviceResult: Returns the encrypted dehydrated device ciphertext.
ciphertext() - Method in class io.github.fherbreteau.vodozemac.backup.PkMessage: Returns the base64-encoded ciphertext of the message.
ciphertext() - Method in class io.github.fherbreteau.vodozemac.megolm.MegolmMessage: Returns the base64-encoded ciphertext of the message.
close() - Method in class io.github.fherbreteau.vodozemac.ecies.InboundCreationResult: Closes this resource by releasing its associated native resources.
close() - Method in class io.github.fherbreteau.vodozemac.ecies.OutboundCreationResult: Closes this resource by releasing its associated native resources.
close() - Method in class io.github.fherbreteau.vodozemac.NativeHandle: Closes this resource by releasing its associated native resources.
close() - Method in class io.github.fherbreteau.vodozemac.olm.InboundCreationResult
compare(InboundGroupSession) - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Compares this session with another session.
connected(InboundGroupSession) - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Checks if two sessions are connected, i.e. created from the same outbound group session.
ConversionException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when a type from rust could not be parsed in Java.
ConversionException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.ConversionException: Constructs a new ConversionException with the specified detail message.
ConversionException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.ConversionException: Constructs a new ConversionException with the specified detail message and a cause.
created() - Method in class io.github.fherbreteau.vodozemac.account.OneTimeKeyGenerationResult: Returns the public parts of the one-time keys that were created.
createInboundSession(OlmSessionVersion, Curve25519PublicKey, OlmMessage) - Method in class io.github.fherbreteau.vodozemac.account.Account: Creates an inbound OlmSession from a pre-key message.
createInboundSession(Curve25519PublicKey, OlmMessage) - Method in class io.github.fherbreteau.vodozemac.account.Account: Creates an inbound OlmSession from a pre-key message, using the default session version.
createOutboundSession(OlmSessionVersion, Curve25519PublicKey, Curve25519PublicKey) - Method in class io.github.fherbreteau.vodozemac.account.Account: Creates an OlmSession with the given identity key and one-time key.
createOutboundSession(Curve25519PublicKey, Curve25519PublicKey) - Method in class io.github.fherbreteau.vodozemac.account.Account: Creates an OlmSession with the given identity key and one-time key, using the default session version.
curve25519Key() - Method in class io.github.fherbreteau.vodozemac.account.Account: Returns the public Curve25519 key of this account.
Curve25519PublicKey - Class in io.github.fherbreteau.vodozemac.types: Represents a Curve25519 public key used for X25519 key agreement.

D

decimals() - Method in class io.github.fherbreteau.vodozemac.sas.SasBytes: Returns the three decimal numbers that can be presented to users to perform the key verification.
decrypt(PkMessage) - Method in class io.github.fherbreteau.vodozemac.backup.PkDecryption: Decrypts a PkMessage that was encrypted for this PkDecryption.
decrypt(MegolmMessage) - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Decrypts the provided Megolm message.
decrypt(OlmMessage) - Method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Decrypts an Olm message and returns the plaintext.
decrypt(String) - Method in class io.github.fherbreteau.vodozemac.ecies.EstablishedEcies: Decrypts the given message using this ECIES session.
DecryptedMessage - Class in io.github.fherbreteau.vodozemac.megolm: A message successfully decrypted by an InboundGroupSession.
DecryptionException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when decrypting an Olm or Megolm message fails.
DecryptionException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.DecryptionException: Constructs a new DecryptionException with the specified detail message.
DecryptionException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.DecryptionException: Constructs a new DecryptionException with the specified detail message and a cause.
defaultVersion() - Static method in enum class io.github.fherbreteau.vodozemac.megolm.MegolmSessionVersion: Returns the default Megolm session version.
defaultVersion() - Static method in enum class io.github.fherbreteau.vodozemac.olm.OlmSessionVersion: Returns the default Olm session version.
DehydratedDeviceResult - Class in io.github.fherbreteau.vodozemac.account: Result of creating a dehydrated device from an Account.
diffieHellman(String) - Method in class io.github.fherbreteau.vodozemac.sas.Sas: Establishes a SAS secret by performing a Diffie-Hellman handshake with another public key.

E

Ecies - Class in io.github.fherbreteau.vodozemac.ecies: An unestablished ECIES (Elliptic Curve Integrated Encryption Scheme) session.
Ecies() - Constructor for class io.github.fherbreteau.vodozemac.ecies.Ecies: Creates a new, random, unestablished ECIES session.
EciesException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when an ECIES operation fails.
EciesException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.EciesException: Constructs a new EciesException with the specified detail message.
EciesException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.EciesException: Constructs a new EciesException with the specified detail message and a cause.
ed25519Key() - Method in class io.github.fherbreteau.vodozemac.account.Account: Returns the public Ed25519 key of this account.
Ed25519KeyPair - Class in io.github.fherbreteau.vodozemac.types: An Ed25519 key pair used to sign and verify messages.
Ed25519KeyPair() - Constructor for class io.github.fherbreteau.vodozemac.types.Ed25519KeyPair: Creates a new Ed25519KeyPair with a new random private key.
Ed25519PublicKey - Class in io.github.fherbreteau.vodozemac.types: Represents an Ed25519 public key used for signature verification.
Ed25519Signature - Class in io.github.fherbreteau.vodozemac.types: Represents an Ed25519 signature.
emojiIndices() - Method in class io.github.fherbreteau.vodozemac.sas.SasBytes: Returns the indices of 7 emojis that can be presented to users to perform the key verification.
encrypt(byte[]) - Method in class io.github.fherbreteau.vodozemac.backup.PkEncryption: Encrypts the given plaintext and returns the encrypted message.
encrypt(byte[]) - Method in class io.github.fherbreteau.vodozemac.ecies.EstablishedEcies: Encrypts the given plaintext using this ECIES session.
encrypt(byte[]) - Method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Encrypts the given plaintext with the group session.
encrypt(byte[]) - Method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Encrypts the plaintext and returns an OlmMessage.
EncryptionException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when encrypting a message fails.
EncryptionException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.EncryptionException: Constructs a new EncryptionException with the specified detail message.
EncryptionException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.EncryptionException: Constructs a new EncryptionException with the specified detail message and a cause.
ephemeralKey() - Method in class io.github.fherbreteau.vodozemac.backup.PkMessage: Returns the base64-encoded ephemeral Curve25519 public key used to derive the message key for this message.
EQUAL - Enum constant in enum class io.github.fherbreteau.vodozemac.megolm.SessionOrdering: The sessions are the same, with identical first known indices.
equals(Object) - Method in class io.github.fherbreteau.vodozemac.account.DehydratedDeviceResult
equals(Object) - Method in class io.github.fherbreteau.vodozemac.account.IdentityKeys
equals(Object) - Method in class io.github.fherbreteau.vodozemac.account.OneTimeKeyGenerationResult
equals(Object) - Method in class io.github.fherbreteau.vodozemac.backup.PkMessage
equals(Object) - Method in class io.github.fherbreteau.vodozemac.ecies.CheckCode
equals(Object) - Method in class io.github.fherbreteau.vodozemac.ecies.EstablishedEcies
equals(Object) - Method in class io.github.fherbreteau.vodozemac.ecies.InboundCreationResult
equals(Object) - Method in class io.github.fherbreteau.vodozemac.ecies.OutboundCreationResult
equals(Object) - Method in class io.github.fherbreteau.vodozemac.megolm.DecryptedMessage
equals(Object) - Method in class io.github.fherbreteau.vodozemac.megolm.MegolmMessage
equals(Object) - Method in class io.github.fherbreteau.vodozemac.olm.InboundCreationResult
equals(Object) - Method in class io.github.fherbreteau.vodozemac.olm.OlmMessage
equals(Object) - Method in class io.github.fherbreteau.vodozemac.olm.SessionKeys
equals(Object) - Method in class io.github.fherbreteau.vodozemac.sas.SasBytes
equals(Object) - Method in class io.github.fherbreteau.vodozemac.types.Curve25519PublicKey
equals(Object) - Method in class io.github.fherbreteau.vodozemac.types.Ed25519PublicKey
equals(Object) - Method in class io.github.fherbreteau.vodozemac.types.Ed25519Signature
establishedEcies() - Method in class io.github.fherbreteau.vodozemac.ecies.InboundCreationResult: Returns the established ECIES channel.
establishedEcies() - Method in class io.github.fherbreteau.vodozemac.ecies.OutboundCreationResult: Returns the established ECIES channel.
EstablishedEcies - Class in io.github.fherbreteau.vodozemac.ecies: An established ECIES channel that can be used to encrypt and decrypt messages between the two sides of the channel.
EstablishedSas - Class in io.github.fherbreteau.vodozemac.sas: User-friendly key verification using short authentication strings (SAS) with an established shared secret.
establishInboundChannel(String) - Method in class io.github.fherbreteau.vodozemac.ecies.Ecies: Establishes an inbound ECIES channel from an initial message encrypted by the other side.
establishOutboundChannel(String, byte[]) - Method in class io.github.fherbreteau.vodozemac.ecies.Ecies: Establishes an outbound ECIES channel using the other side's Curve25519 public key and an initial plaintext message.
exportAt(int) - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Exports the session at the specified message index.
exportAtFirstKnownIndex() - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Exports the session at its first known message index.

F

fingerprintKey() - Method in class io.github.fherbreteau.vodozemac.account.IdentityKeys: Returns the Ed25519 fingerprint key, used for signing.
firstKnownIndex() - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Returns the first known message index for this session.
forgetFallbackKey() - Method in class io.github.fherbreteau.vodozemac.account.Account: Forgets the previously used fallback key.
fromBase64(String) - Static method in class io.github.fherbreteau.vodozemac.megolm.MegolmMessage: Reconstructs a MegolmMessage from its base64-encoded wire representation.
fromBase64(String) - Static method in class io.github.fherbreteau.vodozemac.types.Curve25519PublicKey: Creates a Curve25519PublicKey from a base64-encoded key string.
fromBase64(String) - Static method in class io.github.fherbreteau.vodozemac.types.Ed25519PublicKey: Creates an Ed25519PublicKey from a base64-encoded key string.
fromBase64(String) - Static method in class io.github.fherbreteau.vodozemac.types.Ed25519Signature: Creates an Ed25519Signature from a base64-encoded signature string.
fromDehydratedDevice(String, String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.account.Account: Creates an Account object from a dehydrated device.
fromKey(String) - Static method in class io.github.fherbreteau.vodozemac.backup.PkDecryption: Creates a PkDecryption from a base64-encoded Curve25519 secret key.
fromKey(String) - Static method in class io.github.fherbreteau.vodozemac.backup.PkEncryption: Creates a PkEncryption instance from a base64-encoded Curve25519 public key.
fromValue(int) - Static method in enum class io.github.fherbreteau.vodozemac.olm.MessageType: Returns the message type corresponding to the given numeric value.
fromVersion(int) - Static method in enum class io.github.fherbreteau.vodozemac.megolm.MegolmSessionVersion: Returns the session version corresponding to the given numeric value.
fromVersion(int) - Static method in enum class io.github.fherbreteau.vodozemac.olm.OlmSessionVersion: Returns the session version corresponding to the given numeric value.
fromVersion(E[], int, String) - Static method in interface io.github.fherbreteau.vodozemac.SessionVersion: Resolves the given numeric version to its corresponding enum constant.

G

generateFallbackKey() - Method in class io.github.fherbreteau.vodozemac.account.Account: Generates a single new fallback key.
generateOneTimeKeys(long) - Method in class io.github.fherbreteau.vodozemac.account.Account: Generates the supplied number of one-time keys.

H

hashCode() - Method in class io.github.fherbreteau.vodozemac.account.DehydratedDeviceResult
hashCode() - Method in class io.github.fherbreteau.vodozemac.account.IdentityKeys
hashCode() - Method in class io.github.fherbreteau.vodozemac.account.OneTimeKeyGenerationResult
hashCode() - Method in class io.github.fherbreteau.vodozemac.backup.PkMessage
hashCode() - Method in class io.github.fherbreteau.vodozemac.ecies.CheckCode
hashCode() - Method in class io.github.fherbreteau.vodozemac.ecies.EstablishedEcies
hashCode() - Method in class io.github.fherbreteau.vodozemac.ecies.InboundCreationResult
hashCode() - Method in class io.github.fherbreteau.vodozemac.ecies.OutboundCreationResult
hashCode() - Method in class io.github.fherbreteau.vodozemac.megolm.DecryptedMessage
hashCode() - Method in class io.github.fherbreteau.vodozemac.megolm.MegolmMessage
hashCode() - Method in class io.github.fherbreteau.vodozemac.olm.InboundCreationResult
hashCode() - Method in class io.github.fherbreteau.vodozemac.olm.OlmMessage
hashCode() - Method in class io.github.fherbreteau.vodozemac.olm.SessionKeys
hashCode() - Method in class io.github.fherbreteau.vodozemac.sas.SasBytes
hashCode() - Method in class io.github.fherbreteau.vodozemac.types.Curve25519PublicKey
hashCode() - Method in class io.github.fherbreteau.vodozemac.types.Ed25519PublicKey
hashCode() - Method in class io.github.fherbreteau.vodozemac.types.Ed25519Signature
hasReceivedMessage() - Method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Checks whether a message has ever been received and decrypted from the other side.

I

identityKey() - Method in class io.github.fherbreteau.vodozemac.account.IdentityKeys: Returns the Curve25519 identity key, used to establish shared secrets.
identityKey() - Method in class io.github.fherbreteau.vodozemac.olm.SessionKeys: Returns the long-term Curve25519 public key of the session initiator.
identityKeys() - Method in class io.github.fherbreteau.vodozemac.account.Account: Returns the identity keys of this account.
IdentityKeys - Class in io.github.fherbreteau.vodozemac.account: Holds the two public identity keys of an Account.
importSession(String) - Static method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Creates a new InboundGroupSession from an exported session key with the default version.
importSession(String, MegolmSessionVersion) - Static method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Creates a new InboundGroupSession from an exported session key.
InboundCreationResult - Class in io.github.fherbreteau.vodozemac.ecies: The result of an inbound ECIES channel establishment.
InboundCreationResult - Class in io.github.fherbreteau.vodozemac.olm: Return type for the creation of an inbound OlmSession.
InboundGroupSession - Class in io.github.fherbreteau.vodozemac.megolm: A Megolm inbound group session represents a single receiving participant in an encrypted group communication involving multiple recipients.
InboundGroupSession(String) - Constructor for class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Creates a new inbound group session from a session key received over an authenticated channel using the default megolm version.
InboundGroupSession(String, MegolmSessionVersion) - Constructor for class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Creates a new inbound group session from a session key received over an authenticated channel.
INFO - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
initialMessage() - Method in class io.github.fherbreteau.vodozemac.ecies.OutboundCreationResult: Returns the initial message to send to the recipient.
INPUT - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
invalidate() - Method in class io.github.fherbreteau.vodozemac.NativeHandle: Invalidates this handle without releasing its native resources, because ownership of the native object has been transferred elsewhere.
io.github.fherbreteau.vodozemac - package io.github.fherbreteau.vodozemac
io.github.fherbreteau.vodozemac.account - package io.github.fherbreteau.vodozemac.account
io.github.fherbreteau.vodozemac.backup - package io.github.fherbreteau.vodozemac.backup
io.github.fherbreteau.vodozemac.ecies - package io.github.fherbreteau.vodozemac.ecies
io.github.fherbreteau.vodozemac.exception - package io.github.fherbreteau.vodozemac.exception
io.github.fherbreteau.vodozemac.megolm - package io.github.fherbreteau.vodozemac.megolm
io.github.fherbreteau.vodozemac.olm - package io.github.fherbreteau.vodozemac.olm
io.github.fherbreteau.vodozemac.sas - package io.github.fherbreteau.vodozemac.sas
io.github.fherbreteau.vodozemac.types - package io.github.fherbreteau.vodozemac.types

K

KEY - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
KeyException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when decoding or validating a cryptographic key fails.
KeyException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.KeyException: Constructs a new KeyException with the specified detail message.
KeyException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.KeyException: Constructs a new KeyException with the specified detail message and a cause.
KeyValidator - Class in io.github.fherbreteau.vodozemac: Utility for validating encryption keys used by the vodozemac pickle format.

L

loadLibrary() - Static method in class io.github.fherbreteau.vodozemac.NativeLibraryLoader: Loads the native vodozemac library for the current platform.

M

mac() - Method in class io.github.fherbreteau.vodozemac.backup.PkMessage: Returns the base64-encoded MAC (message authentication code) of the message.
mac() - Method in class io.github.fherbreteau.vodozemac.megolm.MegolmMessage: Returns the base64-encoded MAC (message authentication code) of the message.
MAC - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
markKeysAsPublished() - Method in class io.github.fherbreteau.vodozemac.account.Account: Marks all currently unpublished one-time and fallback keys as published.
maxNumberOfOneTimeKeys() - Method in class io.github.fherbreteau.vodozemac.account.Account: Returns the maximum number of one-time keys the client should keep on the server.
MegolmMessage - Class in io.github.fherbreteau.vodozemac.megolm: A structured Megolm message, containing the ciphertext, message index, MAC, and Ed25519 signature.
MegolmSessionVersion - Enum Class in io.github.fherbreteau.vodozemac.megolm: Represents the version of the Megolm session protocol to use.
merge(InboundGroupSession) - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Merges this session with the given other session, picking the best parts from each.
MESSAGE - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
messageIndex() - Method in class io.github.fherbreteau.vodozemac.megolm.DecryptedMessage: Returns the message index, used to detect replay attacks.
messageIndex() - Method in class io.github.fherbreteau.vodozemac.megolm.MegolmMessage: Returns the message index, which indicates the ratchet position at which the message was encrypted.
messageIndex() - Method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Returns the current message index.
MessageType - Enum Class in io.github.fherbreteau.vodozemac.olm: Represents the type of an Olm message.

N

NativeHandle - Class in io.github.fherbreteau.vodozemac: Abstract base class for all objects backed by a native handle (raw pointer).
NativeHandle(long, LongConsumer) - Constructor for class io.github.fherbreteau.vodozemac.NativeHandle
NativeLibraryLoader - Class in io.github.fherbreteau.vodozemac: Handles loading of the native vodozemac library for the current platform.
nativePtr() - Method in class io.github.fherbreteau.vodozemac.NativeHandle
nonce() - Method in class io.github.fherbreteau.vodozemac.account.DehydratedDeviceResult: Returns the nonce used to encrypt the dehydrated device.
NORMAL - Enum constant in enum class io.github.fherbreteau.vodozemac.olm.MessageType: A normal message (type 1), sent over an already-established Olm session.

O

OlmMessage - Class in io.github.fherbreteau.vodozemac.olm: A structured Olm message, consisting of a MessageType and a base64-encoded ciphertext body.
OlmSession - Class in io.github.fherbreteau.vodozemac.olm: An Olm session represents one end of an encrypted communication channel between two participants.
OlmSessionVersion - Enum Class in io.github.fherbreteau.vodozemac.olm: Represents the version of the Olm session protocol to use.
oneTimeKey() - Method in class io.github.fherbreteau.vodozemac.olm.SessionKeys: Returns the one-time Curve25519 public key that the initiator downloaded from a key server, which was previously created and published by the recipient.
OneTimeKeyGenerationResult - Class in io.github.fherbreteau.vodozemac.account: Result of generating one-time keys on an Account.
OTHER - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
ourPublicKey() - Method in class io.github.fherbreteau.vodozemac.sas.EstablishedSas: Returns the public key that was created by us, that was used to establish the shared secret.
OutboundCreationResult - Class in io.github.fherbreteau.vodozemac.ecies: The result of an outbound ECIES channel establishment.
OutboundGroupSession - Class in io.github.fherbreteau.vodozemac.megolm: A Megolm outbound group session represents a single sending participant in an encrypted group communication context containing multiple receiving parties.
OutboundGroupSession() - Constructor for class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Constructs a new outbound group session with a random ratchet state and signing key pair.
OutboundGroupSession(MegolmSessionVersion) - Constructor for class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Constructs a new outbound group session with a random ratchet state and signing key pair.

P

ParamNames - Class in io.github.fherbreteau.vodozemac: Shared parameter-name constants used in Objects.requireNonNull messages across the bindings.
pickle() - Method in class io.github.fherbreteau.vodozemac.account.Account: Converts the account into a JSON string representation.
pickle() - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Converts the inbound group session into a JSON string representation.
pickle() - Method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Converts the group session into a JSON string representation.
pickle() - Method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Converts the session into a JSON string representation.
pickle() - Method in class io.github.fherbreteau.vodozemac.types.Ed25519KeyPair: Converts the key pair into a JSON string representation.
pickle(byte[]) - Method in class io.github.fherbreteau.vodozemac.account.Account: Encrypts the account using the given 32-byte key and returns the encrypted representation.
pickle(byte[]) - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Encrypts the inbound group session using the given 32-byte key and returns the encrypted representation.
pickle(byte[]) - Method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Encrypts the group session using the given 32-byte key and returns the encrypted representation.
pickle(byte[]) - Method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Encrypts the session using the given 32-byte key and returns the encrypted representation.
PICKLE_DATA - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
PICKLE_KEY - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
PickleException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when serializing or deserializing a vodozemac pickle fails.
PickleException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.PickleException: Constructs a new PickleException with the specified detail message.
PickleException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.PickleException: Constructs a new PickleException with the specified detail message and a cause.
pickleLegacy(byte[]) - Method in class io.github.fherbreteau.vodozemac.account.Account: Converts the account into the libolm pickle format, encrypted with the given 32-byte key.
pickleLegacy(byte[]) - Method in class io.github.fherbreteau.vodozemac.backup.PkDecryption: Pickles this PkDecryption into the legacy libolm pickle format.
PkDecryption - Class in io.github.fherbreteau.vodozemac.backup: The decryption component of the PK Encryption module.
PkDecryption() - Constructor for class io.github.fherbreteau.vodozemac.backup.PkDecryption: Creates a new PkDecryption with a fresh random Curve25519 key pair.
PkEncryption - Class in io.github.fherbreteau.vodozemac.backup: The encryption component of the PK Encryption module.
PkMessage - Class in io.github.fherbreteau.vodozemac.backup: A message that was encrypted using a PkEncryption object.
plaintext() - Method in class io.github.fherbreteau.vodozemac.ecies.InboundCreationResult: Returns the decrypted plaintext of the initial message.
plaintext() - Method in class io.github.fherbreteau.vodozemac.megolm.DecryptedMessage: Returns the decrypted plaintext of the message.
plaintext() - Method in class io.github.fherbreteau.vodozemac.olm.InboundCreationResult: Returns the plaintext of the pre-key message that was decrypted as part of the session creation.
PLAINTEXT - Static variable in class io.github.fherbreteau.vodozemac.ParamNames
PRE_KEY - Enum constant in enum class io.github.fherbreteau.vodozemac.olm.MessageType: A pre-key message (type 0), used to establish a new Olm session.
publicKey() - Method in class io.github.fherbreteau.vodozemac.backup.PkDecryption: Returns the Curve25519 public key associated with this PkDecryption.
publicKey() - Method in class io.github.fherbreteau.vodozemac.ecies.Ecies: Returns the ephemeral Curve25519 public key associated with this session.
publicKey() - Method in class io.github.fherbreteau.vodozemac.ecies.EstablishedEcies: Returns our Curve25519 public key that was used to establish the ECIES channel.
publicKey() - Method in class io.github.fherbreteau.vodozemac.sas.Sas: Returns the public key that can be used to establish a shared secret.
publicKey() - Method in class io.github.fherbreteau.vodozemac.types.Ed25519KeyPair: Returns the public key of this key pair.

R

removed() - Method in class io.github.fherbreteau.vodozemac.account.OneTimeKeyGenerationResult: Returns the public parts of the one-time keys that were discarded to make room for the newly created ones.

S

Sas - Class in io.github.fherbreteau.vodozemac.sas: User-friendly key verification using short authentication strings (SAS).
Sas() - Constructor for class io.github.fherbreteau.vodozemac.sas.Sas: Creates a new random verification object.
SasBytes - Class in io.github.fherbreteau.vodozemac.sas: Bytes generated from a shared secret that can be used as the short authentication string (SAS).
SasException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when SAS (Short Authentication String) verification fails.
SasException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.SasException: Constructs a new SasException with the specified detail message.
SasException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.SasException: Constructs a new SasException with the specified detail message and a cause.
secretKey() - Method in class io.github.fherbreteau.vodozemac.backup.PkDecryption: Returns the Curve25519 secret key of this PkDecryption.
session() - Method in class io.github.fherbreteau.vodozemac.olm.InboundCreationResult: Returns the OlmSession that was created from the pre-key message.
sessionConfig() - Method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Returns the session configuration (protocol version) used by this session.
sessionConfig() - Method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Returns the session configuration (protocol version) used by this session.
SessionCreationException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when creating an inbound Olm session from a pre-key message fails.
SessionCreationException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.SessionCreationException: Constructs a new SessionCreationException with the specified detail message.
SessionCreationException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.SessionCreationException: Constructs a new SessionCreationException with the specified detail message and a cause.
sessionId() - Method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Returns the unique ID of this session.
sessionId() - Method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Returns the globally unique session ID, in base64-encoded form.
sessionId() - Method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Returns the globally unique session ID, in base64-encoded form.
sessionId() - Method in class io.github.fherbreteau.vodozemac.olm.SessionKeys: Returns the globally unique session ID, base64-encoded.
sessionKey() - Method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Exports the group session into a session key.
sessionKeys() - Method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Returns the keys associated with this session.
SessionKeys - Class in io.github.fherbreteau.vodozemac.olm: The set of Curve25519 public keys that were used to establish an Olm session.
SessionOrdering - Enum Class in io.github.fherbreteau.vodozemac.megolm: The result of a comparison between two InboundGroupSession types.
SessionVersion - Interface in io.github.fherbreteau.vodozemac: Common interface for session version enums such as OlmSessionVersion and MegolmSessionVersion.
sign(byte[]) - Method in class io.github.fherbreteau.vodozemac.account.Account: Signs the given message using the Ed25519 fingerprint key.
sign(byte[]) - Method in class io.github.fherbreteau.vodozemac.types.Ed25519KeyPair: Signs the given message using the private key.
sign(String) - Method in class io.github.fherbreteau.vodozemac.account.Account: Signs the given message using the Ed25519 fingerprint key.
sign(String) - Method in class io.github.fherbreteau.vodozemac.types.Ed25519KeyPair: Signs the given message using the private key.
signature() - Method in class io.github.fherbreteau.vodozemac.megolm.MegolmMessage: Returns the Ed25519 signature of the message.
SignatureException - Exception Class in io.github.fherbreteau.vodozemac.exception: Thrown when signature verification fails.
SignatureException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.SignatureException: Constructs a new SignatureException with the specified detail message.
SignatureException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.SignatureException: Constructs a new SignatureException with the specified detail message and a cause.
storedOneTimeKeyCount() - Method in class io.github.fherbreteau.vodozemac.account.Account: Returns the number of one-time keys stored locally.

T

theirPublicKey() - Method in class io.github.fherbreteau.vodozemac.sas.EstablishedSas: Returns the public key that was created by the other party, that was used to establish the shared secret.
toBase64() - Method in class io.github.fherbreteau.vodozemac.types.Curve25519PublicKey
toBase64() - Method in class io.github.fherbreteau.vodozemac.types.Ed25519PublicKey
toBase64() - Method in class io.github.fherbreteau.vodozemac.types.Ed25519Signature
toDehydratedDevice(byte[]) - Method in class io.github.fherbreteau.vodozemac.account.Account: Creates a dehydrated device from the account.
toDigit() - Method in class io.github.fherbreteau.vodozemac.ecies.CheckCode: Returns the check code as a two-digit base-10 number.
toJson() - Method in class io.github.fherbreteau.vodozemac.olm.OlmMessage: Returns the JSON representation of this message, in the format {"body":"<base64>","type":<int>}.
toString() - Method in class io.github.fherbreteau.vodozemac.account.DehydratedDeviceResult
toString() - Method in class io.github.fherbreteau.vodozemac.account.IdentityKeys
toString() - Method in class io.github.fherbreteau.vodozemac.account.OneTimeKeyGenerationResult
toString() - Method in class io.github.fherbreteau.vodozemac.backup.PkMessage
toString() - Method in class io.github.fherbreteau.vodozemac.ecies.CheckCode
toString() - Method in class io.github.fherbreteau.vodozemac.ecies.InboundCreationResult
toString() - Method in class io.github.fherbreteau.vodozemac.ecies.OutboundCreationResult
toString() - Method in class io.github.fherbreteau.vodozemac.megolm.DecryptedMessage
toString() - Method in class io.github.fherbreteau.vodozemac.megolm.MegolmMessage: Returns the base64-encoded wire representation of this message.
toString() - Method in class io.github.fherbreteau.vodozemac.olm.InboundCreationResult
toString() - Method in class io.github.fherbreteau.vodozemac.olm.OlmMessage
toString() - Method in class io.github.fherbreteau.vodozemac.olm.SessionKeys
toString() - Method in class io.github.fherbreteau.vodozemac.sas.SasBytes
toString() - Method in class io.github.fherbreteau.vodozemac.types.Curve25519PublicKey
toString() - Method in class io.github.fherbreteau.vodozemac.types.Ed25519PublicKey
toString() - Method in class io.github.fherbreteau.vodozemac.types.Ed25519Signature
type() - Method in class io.github.fherbreteau.vodozemac.olm.OlmMessage: Returns the type of this message.

U

UNCONNECTED - Enum constant in enum class io.github.fherbreteau.vodozemac.megolm.SessionOrdering: The sessions are not connected and cannot be compared.
unpickle(String) - Static method in class io.github.fherbreteau.vodozemac.account.Account: Restores an Account from a previously saved JSON string.
unpickle(String) - Static method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Restores an InboundGroupSession from a previously saved JSON string.
unpickle(String) - Static method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Restores an OutboundGroupSession from a previously saved JSON string.
unpickle(String) - Static method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Restores an OlmSession from a previously saved JSON string.
unpickle(String) - Static method in class io.github.fherbreteau.vodozemac.types.Ed25519KeyPair: Restores an Ed25519KeyPair from a previously saved JSON string.
unpickle(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.account.Account: Restores an Account from an encrypted string using a 32-byte key.
unpickle(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Restores an InboundGroupSession from an encrypted string using a 32-byte key.
unpickle(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Restores an OutboundGroupSession from an encrypted string using a 32-byte key.
unpickle(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Restores an OlmSession from an encrypted string using a 32-byte key.
unpickleLegacy(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.account.Account: Restores an Account from a legacy libolm pickle format.
unpickleLegacy(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.backup.PkDecryption: Restores a PkDecryption from a legacy libolm pickle format.
unpickleLegacy(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.megolm.InboundGroupSession: Restores an InboundGroupSession from a legacy libolm pickle format.
unpickleLegacy(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.megolm.OutboundGroupSession: Restores an OutboundGroupSession from a legacy libolm pickle format.
unpickleLegacy(String, byte[]) - Static method in class io.github.fherbreteau.vodozemac.olm.OlmSession: Restores an OlmSession from a legacy libolm pickle format.
unpublishedFallbackKey() - Method in class io.github.fherbreteau.vodozemac.account.Account: Returns the currently unpublished fallback key.
unpublishedOneTimeKeys() - Method in class io.github.fherbreteau.vodozemac.account.Account: Returns the currently unpublished one-time keys.

V

V1 - Enum constant in enum class io.github.fherbreteau.vodozemac.megolm.MegolmSessionVersion: Version 1 — uses truncated MAC, compatible with the original libolm.
V1 - Enum constant in enum class io.github.fherbreteau.vodozemac.olm.OlmSessionVersion: Version 1 — uses truncated MAC, compatible with the original libolm.
V2 - Enum constant in enum class io.github.fherbreteau.vodozemac.megolm.MegolmSessionVersion: Version 2 — uses full-length MAC for stronger integrity protection.
V2 - Enum constant in enum class io.github.fherbreteau.vodozemac.olm.OlmSessionVersion: Version 2 — uses full-length MAC for stronger integrity protection.
validateEncryptionKey(byte[]) - Static method in class io.github.fherbreteau.vodozemac.KeyValidator: Validates that the given key is exactly 256-bit (32-byte), as required by the vodozemac encrypted pickle format.
value() - Method in enum class io.github.fherbreteau.vodozemac.megolm.MegolmSessionVersion: Returns the numeric value of this session version.
value() - Method in enum class io.github.fherbreteau.vodozemac.olm.MessageType: Returns the numeric value of this message type.
value() - Method in enum class io.github.fherbreteau.vodozemac.olm.OlmSessionVersion: Returns the numeric value of this session version.
value() - Method in interface io.github.fherbreteau.vodozemac.SessionVersion: Returns the numeric value of this session version.
valueOf(String) - Static method in enum class io.github.fherbreteau.vodozemac.megolm.MegolmSessionVersion: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.fherbreteau.vodozemac.megolm.SessionOrdering: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.fherbreteau.vodozemac.olm.MessageType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.fherbreteau.vodozemac.olm.OlmSessionVersion: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.fherbreteau.vodozemac.megolm.MegolmSessionVersion: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.fherbreteau.vodozemac.megolm.SessionOrdering: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.fherbreteau.vodozemac.olm.MessageType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.fherbreteau.vodozemac.olm.OlmSessionVersion: Returns an array containing the constants of this enum class, in the order they are declared.
verify(byte[], Ed25519Signature) - Method in class io.github.fherbreteau.vodozemac.types.Ed25519PublicKey: Verifies the signature of the given message.
verify(String, Ed25519Signature) - Method in class io.github.fherbreteau.vodozemac.types.Ed25519PublicKey: Verifies the signature of the given message.
verifyMac(String, String, String) - Method in class io.github.fherbreteau.vodozemac.sas.EstablishedSas: Verifies a MAC that was previously created using EstablishedSas.calculateMac(String, String).
version() - Static method in class io.github.fherbreteau.vodozemac.Vodozemac: Returns the version of the underlying vodozemac Rust crate.
Vodozemac - Class in io.github.fherbreteau.vodozemac: Entry point and utility class for the vodozemac library.
VodozemacException - Exception Class in io.github.fherbreteau.vodozemac.exception: Base exception class for all errors thrown by the vodozemac Java bindings.
VodozemacException(String) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.VodozemacException: Constructs a new VodozemacException with the specified detail message.
VodozemacException(String, Throwable) - Constructor for exception class io.github.fherbreteau.vodozemac.exception.VodozemacException: Constructs a new VodozemacException with the specified detail message and a cause.

W

withInfo(String) - Static method in class io.github.fherbreteau.vodozemac.ecies.Ecies: Creates a new, random, unestablished ECIES session with the given application info.
WORSE - Enum constant in enum class io.github.fherbreteau.vodozemac.megolm.SessionOrdering: The first session has a worse (higher) initial message index than the second one.

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form