Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- A - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Authentication message type
- addMessageField(WfMessageField) - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Encodes a Whiteflag message field and adds it to the end of the binary buffer
- addMetadata(String, String) - Method in class org.whiteflagprotocol.java.WfMessage
-
Adds metadata to the Whiteflag message if not already existing
- AES_256_CTR_ECDH - Enum constant in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
Encryption Method 1: AES-256-CTR with negotiated key
- AES_256_CTR_PSK - Enum constant in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
Encryption Method : AES-256-CTR with pre-shared key
- algorithmName - Variable in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
The name of the algorithm for this encryption method, i.a.w.
- ANY - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Undefined message type
- append(WfBinaryBuffer) - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Appends a binary buffer to this binary buffer
- append(WfMessageSegment) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Appends additional fields to this message segment if constructing complex message bodies
- appendBits(byte[]) - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Appends a bytes array to the binary buffer
- appendBits(byte[], int) - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Appends the specified number of bits from a bytes array to the binary buffer
- authenticationBodyFields - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Authentication message body fields
B
- BIN - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
1-bit binary encoded bit
- BINPREFIX - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The "0b" prefix of a binary string
- BINRADIX - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The radic of a binary digit
- BIT - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The bit size of a bit
- bitLength() - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Returns the bit length of the binary buffer
- bitLength() - Method in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
Returns the bit length the totol number of bits for a fixed length field, else the bits to encode a single character
- bitLength() - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Gets the bit length of the encoded field
- bitLength() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Returns the bit length of this segment, excluding the last variable length field if not set
- bitLength(int) - Method in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
Returns the bit length of a field for a given encoding and unencoded field byte length
- bitLength(int) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Returns the bit length up to and including the specified field, excluding the last variable length field if not set
- bitLength(String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Returns the bit length of this segment, excluding the last variable length field if not set
- body - Variable in class org.whiteflagprotocol.java.core.WfBasicMessage
-
The message body
- BYTE - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The bit size of a byte
- byteLength() - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Returns the byte length of the binary buffer
- byteLength() - Method in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
Returns the byte length for a fixed length unencoded field, else -1
- byteLength() - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Gets the byte length of the unencoded field value
- byteLength() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Returns the byte length of this segment, excluding the last variable length field if not set
- byteLength(int) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Returns the byte length of this segment up to and including the specified field, excluding the last variable length field if not set
- byteLength(String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Returns the byte length of this segment, excluding the last variable length field if not set
C
- charset() - Method in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
Returns the allowed charters for a given encoding
- cipherName - Variable in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
The cipher name for this encryption method i.a.w.
- compile(String[]) - Method in class org.whiteflagprotocol.java.core.WfMessageCreator
-
Compiles a new Whiteflag base message object from field values
- compile(String[]) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message object from field values
- compressPublicKey(ECPublicKey) - Static method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Compresses an ECDH public key to a raw 264-bit compressed public ECDH key
- concatinateBits(byte[], int, byte[], int) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Concatinates two bitsets
- convertToByteArray(String) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Converts a hexadecimal string to a byte array
- convertToByteArray(String) - Static method in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
Converts a hexadecimal string to a byte array
- convertToHexString(byte[]) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Converts a byte array to a hexadecimal string
- convertToHexString(byte[]) - Static method in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
Converts a byte array to a hexadecimal string
- copy() - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Makes a copy of the binary buffer
- copy() - Method in class org.whiteflagprotocol.java.WfMessage
-
Copies the base of this message into a new message, without any metadata
- create() - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Creates a new Whiteflag binary buffer
- create() - Method in class org.whiteflagprotocol.java.core.WfMessageCreator
-
Creates the Whiteflag message base
- create(String) - Static method in class org.whiteflagprotocol.java.util.WfJsonMessage
-
Creates a new JSON representation of a Whiteflag message from a serialized JSON string
- create(String) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new empty Whiteflag message object of the specified type
- createKeyPair() - Static method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Creates a new random ECDH key pair with the curve specified for Whiteflag key negotiation
- createKeyPair(ECPrivateKey) - Static method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Creates an ECDH key pair from an existing private key with the curve specified for Whiteflag key negotiation
- createPrivateKey(byte[]) - Static method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Creates an ECDH private key object from a byte array
- createPublicKey(byte[]) - Static method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Creates an ECDH public key object from a byte array
- createPublicKey(String) - Static method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Creates an ECDH public key object from a byte array
- createRequestFields(int) - Method in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Returns an array with additional Whiteflag sign/signal message body request fields
- cropBits(byte[], int) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Shortens the byte array to fit the length of the used bits
- cryptoBodyFields - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Cryptographic message body fields
- CURVENAME - Static variable in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
The name of the elleptic curve used by Whiteflag for ECDH hey negotiation
D
- D - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Danger Sign message type
- DATETIME - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
4-bit binary encoded date-time coordinate
- debugInfo() - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Gives debug information of the field
- DEC - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
4-bit binary encoded decimal
- decode(byte[]) - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Decodes the compressed binary data and sets field value
- decode(byte[]) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message from a byte array with an binary encoded message
- decode(String) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message from a hexadecimal string represaentation of an encoded message
- decode(WfBinaryBuffer) - Method in class org.whiteflagprotocol.java.core.WfMessageCreator
-
Decodes an encoded Whiteflag message and creates a new Whiteflag base message object
- decode(WfBinaryBuffer) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message from a binary buffer
- decode(WfBinaryBuffer, int, int) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Decodes this message segment from the provided encoded message
- decodeBDX(byte[], int) - Static method in class org.whiteflagprotocol.java.core.WfMessageCodec
-
Decodes a binary buffer into a (hexa)decimal string
- decodeBIN(byte[], int) - Static method in class org.whiteflagprotocol.java.core.WfMessageCodec
-
Decodes a binary buffer into a binary string
- decodeField(WfMessageField, byte[]) - Static method in class org.whiteflagprotocol.java.core.WfMessageCodec
-
Sets the field value from a binary buffer
- decrypt(byte[]) - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Decrypts the provided data
- decrypt(byte[], WfAccount, WfAccount, byte[]) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message from an encyrpted binary buffer and metadata
- decrypt(String) - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Decrypts the provided data
- decrypt(String, WfAccount, WfAccount, String) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message from an encyrpted binary buffer and metadata
- decrypt(WfBinaryBuffer, WfAccount, WfAccount, byte[]) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message from an encyrpted binary buffer and metadata
- define(String, String, WfMessageCodec.Encoding, int, int) - Static method in class org.whiteflagprotocol.java.core.WfMessageField
-
Defines a new Whiteflag message field
- deserialize(String) - Method in class org.whiteflagprotocol.java.core.WfMessageCreator
-
Deserializes a serialized Whiteflag message and creates a new Whiteflag base message object
- deserialize(String) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message object from a serialized message
- deserialize(String, int) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Deserializes this message segment from the provided serialized message
- deserializeJson(String) - Static method in class org.whiteflagprotocol.java.WfMessage
-
Creates a new Whiteflag message object from a serialized JSON message
- destroy() - Method in class org.whiteflagprotocol.java.crypto.WfAuthToken
-
Destroys this Whiteflag authentication token by clearing the shared secret
- destroy() - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Destroys this Whiteflag cipher by clearing the encryption key
- destroy() - Method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Destroys this Whiteflag ECDH key pair by clearing the private key
- destroy() - Method in class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Destroys this Whiteflag cipher by clearing the encryption key
- DURATION - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
4-bit binary encoded time duration
E
- E - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Emergency Signal message type
- encode() - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Encodes the Whiteflag message
- encode() - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Encodes the message field into compressed binary data
- encode() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Encodes this message segment
- encode() - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns the cached encoded/encrypted message, or else it encodes/encrypts and caches the message
- encodeBDX(String) - Static method in class org.whiteflagprotocol.java.core.WfMessageCodec
-
Encodes a (hexa)decimal string into a binary buffer
- encodeBIN(String) - Static method in class org.whiteflagprotocol.java.core.WfMessageCodec
-
Encodes a binary string into a binary buffer
- encodeField(WfMessageField) - Static method in class org.whiteflagprotocol.java.core.WfMessageCodec
-
Encodes a Whiteflag message field to compressed binary representation
- encodeLatLong(String) - Static method in class org.whiteflagprotocol.java.core.WfMessageCodec
-
Encodes a datum string into binary buffer
- encoding - Variable in class org.whiteflagprotocol.java.core.WfMessageField
-
The encoding of the field
- encrypt() - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns the encoded/encrypted message; identical to encode()
- encrypt(byte[]) - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Encrypts the provided data
- encrypt(String) - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Encrypts the provided data
- endByte - Variable in class org.whiteflagprotocol.java.core.WfMessageField
-
The ending byte (not included) of the field in a serialized / uncompressed message
- errorType - Variable in exception org.whiteflagprotocol.java.util.WfUtilException
-
Whiteflag util error category as defined by
WfUtilException.ErrorType
- errorType - Variable in exception org.whiteflagprotocol.java.WfException
-
Whiteflag error category as defined by
WfException.ErrorType
- extractBits(int) - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Returns a byte array with a subset of the bits in the buffer from the specified start bit to the end
- extractBits(int, int) - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Returns a byte array with a subset of the bits in the buffer
- extractMessageField(WfMessageField, int) - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Extracts and decodes a Whiteflag message field from the binary buffer
F
- F - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Free Text message type
- fieldValue - Variable in enum class org.whiteflagprotocol.java.crypto.WfAuthMethod
-
The indicator used in the VerificationMethod message field for this authentication method
- fieldValue - Variable in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
The value used in a Whiteflag message to indicate the encryption method
- freetextBodyFields - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Free text message body fields
- from(WfMessageField) - Static method in class org.whiteflagprotocol.java.core.WfMessageField
-
Creates a new Whiteflag message field from an existing field, without copying the value
- from(WfMessageField, int) - Static method in class org.whiteflagprotocol.java.core.WfMessageField
-
Creates a new Whiteflag message field from an existing field, without copying the value
- fromByteArray(byte[]) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Creates a new Whiteflag binary encoded message buffer from a byte array
- fromByteArray(byte[], int) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Creates a new Whiteflag binary encoded message buffer from a byte array
- fromCode(String) - Static method in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Creates the message type from the message code
- fromFieldValue(String) - Static method in enum class org.whiteflagprotocol.java.crypto.WfAuthMethod
-
Returns the encryption method from the indicator value
- fromFieldValue(String) - Static method in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
Returns the encryption method from the indicator value
- fromHexString(String) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Creates a new Whiteflag binary encoded message buffer from a hexadecimal string
- fromKey(WfEncryptionKey) - Static method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Creates a new Whiteflag cipher instance from a Whiteflag encryption key
G
- genericHeaderFields - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Generic message header fields
- get() - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Gets the value of the message field
- get(int) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Gets the value of the field specified by index
- get(String) - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Gets the value of the specified field
- get(String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Gets the value of the field specified by name
- get(String) - Method in class org.whiteflagprotocol.java.WfMessage
-
Gets the value of the specified field
- getAddress() - Method in interface org.whiteflagprotocol.java.WfAccount
-
Returns the blockchain address as a string in the encoding specified for that specific blockchain
- getAllFields() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Gets all fields from this message segment
- getAuthToken() - Method in interface org.whiteflagprotocol.java.WfAccount
-
Gets the authentication token sent with an A2 message to identify the originator associated with this account
- getAuthURL() - Method in interface org.whiteflagprotocol.java.WfAccount
-
Gets the authentication URL sent with an A1 message used to identify the originator associated with this account
- getBinaryAddress() - Method in interface org.whiteflagprotocol.java.WfAccount
-
Provides the binary blockchain address indepent from the representation for that blockchain
- getBody() - Method in class org.whiteflagprotocol.java.util.WfJsonMessage
-
Gets the message body
- getBodyFields() - Method in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Returns an array with the body fields
- getCode() - Method in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Returns the message code string
- getContext() - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Gets the current context to which the encryption key is bound
- getEcdhKeyPair() - Method in interface org.whiteflagprotocol.java.WfAccount
-
Gets the own ECDH key pair used to negatiate keys with other participants
- getEcdhPublicKey() - Method in interface org.whiteflagprotocol.java.WfAccount
-
Gets the other's ECDH public key used to negatioate a key with this participant's account
- getEncryptionMethod() - Method in class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Returns the encryption method
- getField(int) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Gets the field specified by index
- getField(String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Gets the field specified by name
- getFieldIndex(String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Gets the index of the field specified by name
- getFieldNames() - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Gets the field names of this message
- getFieldNames() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Returns the field names of the message segment
- getFieldNames() - Method in class org.whiteflagprotocol.java.WfMessage
-
Gets the field names of this message
- getHeader() - Method in class org.whiteflagprotocol.java.util.WfJsonMessage
-
Gets the message header
- getHeaderFields() - Method in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Returns an array with the header fields
- getInitVector() - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Gets the current initialisation vector
- getInitVector() - Method in class org.whiteflagprotocol.java.WfMessage
-
Gets the non-secret initialisation vector used for encryption and decryption
- getMetadata() - Method in class org.whiteflagprotocol.java.util.WfJsonMessage
-
Gets the message metadata
- getMetadata(String) - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns the requested metadata value of the Whiteflag message
- getMetadataKeys() - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns metadata keys of the Whiteflag message
- getNoFields() - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Gets the number of fields in this message
- getNoFields() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Gets the number of fields in this message segment
- getNoFields() - Method in class org.whiteflagprotocol.java.WfMessage
-
Gets the number of fields in this message
- getOriginator() - Method in class org.whiteflagprotocol.java.WfMessage
-
Gets the originator of this message by their account
- getPublicKey() - Method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Returns the public key of this key pair
- getRawPublicKey() - Method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Returns the raw public key of the ECDH key pair
- getRecipient() - Method in class org.whiteflagprotocol.java.WfMessage
-
Gets the recipient of this message by theri account
- getSecretKey(byte[]) - Method in class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Derive the secret cryptographic key from this Whiteflag encryption key
- getSecretKey(String) - Method in class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Derive the secret cryptographic key from this Whiteflag encryption key
- getSharedKey() - Method in interface org.whiteflagprotocol.java.WfAccount
-
Gets the shared encryption key with this participant's account
- getType() - Method in class org.whiteflagprotocol.java.WfMessage
-
Gets the type of this message
- getUnencryptedHeader(WfBinaryBuffer) - Method in class org.whiteflagprotocol.java.core.WfMessageCreator
-
Decodes an encoded Whiteflag message and creates a new Whiteflag base message object
- getUnencryptedHeaderFields() - Method in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Returns an array with the header fields that are never encrypted
- getVerificationData(byte[]) - Method in class org.whiteflagprotocol.java.crypto.WfAuthToken
-
Generates the Whiteflag verification data to prove possession of the token
- getVerificationData(String) - Method in class org.whiteflagprotocol.java.crypto.WfAuthToken
-
Generates the Whiteflag verification data to prove possession of the token
H
- header - Variable in class org.whiteflagprotocol.java.core.WfBasicMessage
-
The message header
- HEX - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
4-bit binary encoded hexadecimal
- HEXPATTERN - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The regex pattern describing a valid hexadecimal string
- HEXPATTERN - Static variable in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
The regex pattern describing a valid hexadecimnal string
- HEXPREFIX - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The "0x" prefix of a hexadecimal string
- HEXPREFIX - Static variable in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
The "0x" prefix of a hexadecimal string
- HEXRADIX - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The radix of a hexadecimal digit
- HEXRADIX - Static variable in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
The radix of a hexadecimal digit
- hkdf(byte[], byte[], byte[], int) - Static method in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
Performs HKDF key and token derivation for Whiteflag
- hkdf(String, String, String, int) - Static method in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
Performs HKDF key and token derivation for Whiteflag
- HKDF_HASHALG - Static variable in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
The hash algorithm for the HKDF function
- hkdfExpand(byte[], byte[], int) - Static method in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
Performs RFC 5869 HKDF Step 2: expand
- hkdfExtract(byte[], byte[]) - Static method in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
Performs RFC 5869 HKDF Step 1: extract
- hkdfSalt - Variable in enum class org.whiteflagprotocol.java.crypto.WfAuthMethod
-
The salt used by this authentication method in the HKDF function to derive the validation data
- hkdfSalt - Variable in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
The salt used by this encryption method in the HKDF function to derive the encryption key
I
- I - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Infrastructure Sign message type
- isComplete() - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Checks if the buffer is marked as complete and cannot be altered
- isDestroyed() - Method in class org.whiteflagprotocol.java.crypto.WfAuthToken
-
Determine if this Whiteflag cipher has been destroyed.
- isDestroyed() - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Determine if this Whiteflag cipher has been destroyed.
- isDestroyed() - Method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Determine if this Whiteflag cipher has been destroyed.
- isDestroyed() - Method in class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Determine if this Whiteflag cipher has been destroyed.
- isFixedLength() - Method in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
Checks if this encoding requires a fixed field length
- isSelf() - Method in interface org.whiteflagprotocol.java.WfAccount
-
Checks if this is an own account
- isSet() - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Checks if the message field value has been set
- isSet() - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Checks if the cipher has been fully set up for encryption or decryption.
- isValid() - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Checks if this message contains valid data
- isValid() - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Checks if the message field contains a valid value
- isValid() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Checks if all fields of this message segment contain valid data
- isValid() - Method in class org.whiteflagprotocol.java.WfMessage
-
Checks if this message contains valid data
- isValid(String) - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Checks if the specified message field contains valid data
- isValid(String) - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Checks if the provided data is a valid value for this field
- isValid(String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Checks if the specified field contains valid data
- isValid(String) - Method in class org.whiteflagprotocol.java.WfMessage
-
Checks if the specified message field contains valid data
- isValid(String, String) - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Checks if the provided data is valid for the specified message field
- isValid(String, String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Checks if the provided data is valid for the specified field
- isValid(String, String) - Method in class org.whiteflagprotocol.java.WfMessage
-
Checks if the provided data is valid for the specified message field
- IVBYTELENGTH - Static variable in class org.whiteflagprotocol.java.crypto.WfCipher
-
The byte length of an initialisation vector
K
- K - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Cryptographic message type
- keyLength - Variable in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
The byte length of the encryption key for this encryption method
L
- LAT - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
4-bit binary encoded latitude coordinate
- LONG - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
4-bit binary encoded longitude coordinate
M
- M - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Mission Signal message type
- map(Map<String, String>, Map<String, String>) - Method in class org.whiteflagprotocol.java.core.WfMessageCreator
-
Creates a new Whiteflag base message object from header and body maps
- markComplete() - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Marks the buffer as complete and makes it read-only
- method - Variable in class org.whiteflagprotocol.java.crypto.WfAuthToken
-
The authentication method for which this token is valid
- method - Variable in class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
The encryption method for which this key is valid
N
- name - Variable in class org.whiteflagprotocol.java.core.WfMessageField
-
The name of the field
- negotiateKey(byte[]) - Method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Calculates the negotiated shared key with an originator
- negotiateKey(ECPublicKey) - Method in class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Calculates the negotiated shared key with an originator
- NO_ENCRYPTION - Enum constant in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
Encryption Method 0: no encryption
O
- OCTET - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The bit size of an octet
- operationMode - Variable in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
The mode of operation for this encryption method, i.a.w.
- org.whiteflagprotocol.java - package org.whiteflagprotocol.java
-
Whiteflag Protocol Java Library
- org.whiteflagprotocol.java.core - package org.whiteflagprotocol.java.core
-
Whiteflag Protocol Core Library
- org.whiteflagprotocol.java.crypto - package org.whiteflagprotocol.java.crypto
-
Whiteflag Protocol Crypto Library
- org.whiteflagprotocol.java.util - package org.whiteflagprotocol.java.util
-
Whiteflag Protocol Utility Library
P
- P - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Protective Sign message type
- paddingScheme - Variable in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
The padding scheme for this encryption method, i.a.w.
- pattern - Variable in class org.whiteflagprotocol.java.core.WfMessageField
-
The regex pattern defining allowed values
Q
- Q - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Request Signal message type
- QUADBIT - Static variable in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
The bit size of a quadbit
- QUADBIT - Static variable in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
The bit size of a quadbit
R
- R - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Resource message type
- regex() - Method in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
Returns the generic regular expression for a given encoding
- removeStringPrefix(String, String) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Checks for and removes prefix from string
- requestFields - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Request fields
- resourceBodyFields - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Resource message body fields
S
- S - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Status Signal message type
- serialize() - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Serializes the Whiteflag message
- serialize() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Serializes this message segment
- serialize() - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns the cached serialized message, or else it serialzes and caches Whiteflag message
- set(int, String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Sets the value of the field specified by its index in the message segment
- set(String) - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Sets the value of the message field if not already set
- set(String, String) - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Sets the value of the specified field
- set(String, String) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Sets the value of the specified field in the message segment
- set(String, String) - Method in class org.whiteflagprotocol.java.WfMessage
-
Sets the value of the specified field
- setAll(String[]) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Sets all field values of this segment with values from an array
- setAll(String[], int) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Sets all field values of this segment with values from an array
- setAll(Map<String, String>) - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Sets all field values of this segment from a fieldname-to-value mapping
- setContext(byte[]) - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Sets the context to bind the encryption key; in Whiteflag this is usually the blockchain address of the message originator
- setContext(String) - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Sets the context to bind the encryption key; in Whiteflag this is usually the blockchain address of the message originator
- setInitVector() - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Generates a new random initialisation vector.
- setInitVector(byte[]) - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Sets the initialisation vector.
- setInitVector(byte[]) - Method in class org.whiteflagprotocol.java.WfMessage
-
Sets the non-secret initialisation vector used for encryption and decryption, if not already set
- setInitVector(String) - Method in class org.whiteflagprotocol.java.crypto.WfCipher
-
Sets the initialisation vector.
- setInitVector(String) - Method in class org.whiteflagprotocol.java.WfMessage
-
Sets the non-secret initialisation vector used for encryption and decryption, if not already set
- setMetadata(Map<String, String>) - Method in class org.whiteflagprotocol.java.WfMessage
-
Sets the metadata
- setOriginator(WfAccount) - Method in class org.whiteflagprotocol.java.WfMessage
-
Sets the originator sending this message and adds its blockchain address to the metadata
- setRecipient(WfAccount) - Method in class org.whiteflagprotocol.java.WfMessage
-
Sets the intended recipient of this message (if any) and adds its blockchain address to the metadata
- shiftLeft(byte[], int) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Shifts bits in a byte array to the left modulo 8
- shiftRight(byte[], int) - Static method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Shifts bits in a byte array to the right modulo 8
- signsignalBodyFields - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Sign/signal message body fields
- startByte - Variable in class org.whiteflagprotocol.java.core.WfMessageField
-
The starting byte of the field in a serialized / uncompressed message
T
- T - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Test message type
- testBodyFields - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Test message body fields
- toByteArray() - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Returns the Whiteflag encoded message as a byte array
- toByteArray() - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns a byte array with the binary encoded message
- toHexString() - Method in class org.whiteflagprotocol.java.core.WfBinaryBuffer
-
Returns the Whiteflag encoded message as a hexademical string and caches it if the buffer is marked complete
- toHexString() - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns a hexadimal string representation of the binary encoded message
- toJson() - Method in class org.whiteflagprotocol.java.util.WfJsonMessage
-
Creates a serialized JSON representation of a Whiteflag message
- toJson() - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns the serialised JSON representation of the Whiteflag message
- TOKEN_PRESHARED - Enum constant in enum class org.whiteflagprotocol.java.crypto.WfAuthMethod
-
Authentication Method 2: shared token
- tokenLength - Variable in enum class org.whiteflagprotocol.java.crypto.WfAuthMethod
-
The byte length of the validation token for this authentication method
- toMap() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Gets a fieldname-to-value mapping of this message segment
- toString() - Method in class org.whiteflagprotocol.java.core.WfBasicMessage
-
Returns the message as a concatinated string of field values
- toString() - Method in class org.whiteflagprotocol.java.core.WfMessageField
-
Returns the message field as a string
- toString() - Method in class org.whiteflagprotocol.java.core.WfMessageSegment
-
Returns the message segment as a concatinated string of field values
- toString() - Method in class org.whiteflagprotocol.java.WfMessage
-
Returns the message as a concatinated string of field values
- type - Variable in class org.whiteflagprotocol.java.core.WfBasicMessage
-
The type of the message
- type(WfMessageType) - Method in class org.whiteflagprotocol.java.core.WfMessageCreator
-
Creates a new empty Whiteflag base message object of the specified type
U
- UNDEFINED - Static variable in class org.whiteflagprotocol.java.core.WfMessageDefinitions
-
Undefined fields
- UTF8 - Enum constant in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
8-bit binary encoded 1-byte UTF-8 character
V
- valueOf(String) - Static method in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.whiteflagprotocol.java.crypto.WfAuthMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.whiteflagprotocol.java.util.WfUtilException.ErrorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.whiteflagprotocol.java.core.WfMessageCodec.Encoding
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.whiteflagprotocol.java.core.WfMessageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.whiteflagprotocol.java.crypto.WfAuthMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.whiteflagprotocol.java.crypto.WfEncryptionMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.whiteflagprotocol.java.util.WfUtilException.ErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WF_AUTH_ERROR - Enum constant in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Whiteflag authentication error
- WF_CRYPTO_ERROR - Enum constant in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Whiteflag cryptographic error
- WF_FORMAT_ERROR - Enum constant in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Whiteflag message format or field value error
- WF_GENERIC_ERROR - Enum constant in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Generic Whiteflag protocol error
- WF_JSON_ERROR - Enum constant in enum class org.whiteflagprotocol.java.util.WfUtilException.ErrorType
-
Errors when processing (parsing, generating) JSON content
- WF_METADATA_ERROR - Enum constant in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Incorrect or missing Whiteflag message metadata
- WF_REFERENCE_ERROR - Enum constant in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Whiteflag message reference error
- WF_SIGN_ERROR - Enum constant in enum class org.whiteflagprotocol.java.WfException.ErrorType
-
Whiteflag digital signature error
- WF_UTIL_ERROR - Enum constant in enum class org.whiteflagprotocol.java.util.WfUtilException.ErrorType
-
Generic Whiteflag utility error
- WfAccount - Interface in org.whiteflagprotocol.java
-
Whiteflag account interface
- WfAuthMethod - Enum Class in org.whiteflagprotocol.java.crypto
-
Whiteflag authentication parameters enum class
- WfAuthToken - Class in org.whiteflagprotocol.java.crypto
-
Whiteflag authentication token class
- WfAuthToken(byte[]) - Constructor for class org.whiteflagprotocol.java.crypto.WfAuthToken
-
Constructs a new Whiteflag authentication token
- WfAuthToken(String) - Constructor for class org.whiteflagprotocol.java.crypto.WfAuthToken
-
Constructs a new Whiteflag authentication token
- WfBasicMessage - Class in org.whiteflagprotocol.java.core
-
Whiteflag basic message class
- WfBasicMessage(WfBasicMessage) - Constructor for class org.whiteflagprotocol.java.core.WfBasicMessage
-
Creates a basic Whiteflag message from an existing basic message
- WfBasicMessage(WfMessageType, WfMessageSegment, WfMessageSegment) - Constructor for class org.whiteflagprotocol.java.core.WfBasicMessage
-
Creates a basic Whiteflag message from a header and a body
- WfBinaryBuffer - Class in org.whiteflagprotocol.java.core
-
Whiteflag encoded message object
- WfCipher - Class in org.whiteflagprotocol.java.crypto
-
Whiteflag cipher class
- WfCoreException - Exception in org.whiteflagprotocol.java.core
-
Whiteflag protocol core exception class
- WfCoreException(String, Throwable) - Constructor for exception org.whiteflagprotocol.java.core.WfCoreException
-
Creates a generic Whiteflag exception
- WfCryptoException - Exception in org.whiteflagprotocol.java.crypto
-
Whiteflag protocol cryptographic exception class
- WfCryptoException(String, Throwable) - Constructor for exception org.whiteflagprotocol.java.crypto.WfCryptoException
-
Creates a Whiteflag crypto exception
- WfCryptoUtil - Class in org.whiteflagprotocol.java.crypto
-
Whiteflag cryptographic utility class
- WfECDHKeyPair - Class in org.whiteflagprotocol.java.crypto
-
Whiteflag ECDH Key Pair class
- WfECDHKeyPair() - Constructor for class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Constructs a new Whiteflag ECDH key pair
- WfECDHKeyPair(ECPrivateKey) - Constructor for class org.whiteflagprotocol.java.crypto.WfECDHKeyPair
-
Constructs a new Whiteflag ECDH key pair from an existing private key
- WfEncryptionKey - Class in org.whiteflagprotocol.java.crypto
-
Whiteflag encryption key class
- WfEncryptionKey(byte[]) - Constructor for class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Constructs a new Whiteflag encryption key from a raw pre-shared key
- WfEncryptionKey(byte[], WfECDHKeyPair) - Constructor for class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Constructs a new Whiteflag encryption key through ECDH key negotiation
- WfEncryptionKey(String) - Constructor for class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Constructs a new Whiteflag encryption key from a raw pre-shared key
- WfEncryptionKey(String, WfECDHKeyPair) - Constructor for class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Constructs a new Whiteflag encryption key through ECDH key negotiation
- WfEncryptionKey(ECPublicKey, WfECDHKeyPair) - Constructor for class org.whiteflagprotocol.java.crypto.WfEncryptionKey
-
Constructs a new Whiteflag encryption key through ECDH key negotiation
- WfEncryptionMethod - Enum Class in org.whiteflagprotocol.java.crypto
-
Whiteflag encryption parameters enum class
- WfException - Exception in org.whiteflagprotocol.java
-
Whiteflag protocol exception class
- WfException(String, Throwable, WfException.ErrorType) - Constructor for exception org.whiteflagprotocol.java.WfException
-
Creates a Whiteflag exception with a specific error type
- WfException.ErrorType - Enum Class in org.whiteflagprotocol.java
-
Whiteflag protocol error categories
- WfJsonMessage - Class in org.whiteflagprotocol.java.util
-
Whiteflag JSON message representation class
- WfJsonMessage(Map<String, String>, Map<String, String>, Map<String, String>) - Constructor for class org.whiteflagprotocol.java.util.WfJsonMessage
-
Creates a new JSON representation of a Whiteflag message
- WfMessage - Class in org.whiteflagprotocol.java
-
Whiteflag message class
- WfMessageCodec - Class in org.whiteflagprotocol.java.core
-
Whiteflag codec utility class
- WfMessageCodec.Encoding - Enum Class in org.whiteflagprotocol.java.core
-
Whiteflag message compressed field encodings
- WfMessageCreator - Class in org.whiteflagprotocol.java.core
-
Whiteflag message creator class
- WfMessageCreator() - Constructor for class org.whiteflagprotocol.java.core.WfMessageCreator
-
Constructs a Whiteflag message creator
- WfMessageDefinitions - Class in org.whiteflagprotocol.java.core
-
Whiteflag message definitions utility class
- WfMessageField - Class in org.whiteflagprotocol.java.core
-
Whiteflag message field class
- WfMessageSegment - Class in org.whiteflagprotocol.java.core
-
Whiteflag message segment class
- WfMessageSegment(WfMessageField[]) - Constructor for class org.whiteflagprotocol.java.core.WfMessageSegment
-
Constructs a new Whiteflag message segment from an array of message fields, without copying the fields' values
- WfMessageSegment(WfMessageSegment) - Constructor for class org.whiteflagprotocol.java.core.WfMessageSegment
-
Constructs a new Whiteflag message segment from another message segment, also copying the fields' values
- WfMessageType - Enum Class in org.whiteflagprotocol.java.core
-
Whiteflag message type
- WfUtilException - Exception in org.whiteflagprotocol.java.util
-
Whiteflag protocol utility exception class
- WfUtilException(String, Throwable, WfUtilException.ErrorType) - Constructor for exception org.whiteflagprotocol.java.util.WfUtilException
-
Creates a Whiteflag utility exception with a specific utility error type
- WfUtilException.ErrorType - Enum Class in org.whiteflagprotocol.java.util
-
Whiteflag utility error categories
Z
- zeroise(byte[]) - Static method in class org.whiteflagprotocol.java.crypto.WfCryptoUtil
-
Zeroises a byte array
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form