org.wildfly.swarm.jose

Interface Jose

All Known Implementing Classes:

DefaultJoseImpl

public interface Jose

Supports the protection of data with JOSE Signature (RFC7515) and Encryption (RFC7516) using JSON Web Algorithms (RFC7518).

Method Summary

Modifier and Type	Method and Description
String	decrypt(String jwe) Decrypt the encrypted data in the JWE compact or JSON (optional) format.
DecryptionOutput	decryption(String jwe) Decrypt the encrypted data in the JWE compact or JSON (optional) format.
String	encrypt(EncryptionInput input) Encrypt the data in the JWE compact or JSON (optional) format.
String	encrypt(String data) Encrypt the data in the JWE compact or JSON (optional) format..
String	sign(SignatureInput input) Sign the data in the JWS Compact or JSON (optional) format.
String	sign(String data) Sign the data in the JWS Compact or JSON (optional) format.
VerificationOutput	verification(String jws) Verify the signed data in the JWS compact or JSON (optional) format.
VerificationOutput	verificationDetached(String jws, String detachedData) Verify the signed and detached data in the JWS compact or JSON (optional) format.
String	verify(String jws) Verify the signed data in the JWS compact or JSON (optional) format.
String	verifyDetached(String jws, String detachedData) Verify the signed and detached data in the JWS compact or JSON (optional) format.

Method Detail

sign

String sign(String data)
     throws JoseException

Sign the data in the JWS Compact or JSON (optional) format.

Parameters:

data - the data to be signed

Returns:

the signed data in the JWS Compact or JSON format

Throws:

JoseException

sign

String sign(SignatureInput input)
     throws JoseException

Sign the data in the JWS Compact or JSON (optional) format.

Parameters:

input - the data and optional JWS headers which have to be integrity-protected

Returns:

the signed data in the JWS Compact or JSON format

Throws:

JoseException

verify

String verify(String jws)
       throws JoseException

Verify the signed data in the JWS compact or JSON (optional) format.

Parameters:

jws - the JWS sequence.

Returns:

verified data

Throws:

JoseException

verification

VerificationOutput verification(String jws)
                         throws JoseException

Verify the signed data in the JWS compact or JSON (optional) format.

Parameters:

jws - the JWS sequence.

Returns:

verified data and metadata

Throws:

JoseException

verifyDetached

String verifyDetached(String jws,
                      String detachedData)
               throws JoseException

Verify the signed and detached data in the JWS compact or JSON (optional) format.

Parameters:

jws - the JWS sequence.

detachedData - the signed and detached data.

Returns:

verified data

Throws:

JoseException

verificationDetached

VerificationOutput verificationDetached(String jws,
                                        String detachedData)
                                 throws JoseException

Verify the signed and detached data in the JWS compact or JSON (optional) format.

Parameters:

jws - the JWS sequence.

detachedData - the signed and detached data.

Returns:

verified data and metadata

Throws:

JoseException

encrypt

String encrypt(String data)
        throws JoseException

Encrypt the data in the JWE compact or JSON (optional) format..

Parameters:

data - the data to be encrypted

Returns:

the encrypted data

Throws:

JoseException

encrypt

String encrypt(EncryptionInput input)
        throws JoseException

Encrypt the data in the JWE compact or JSON (optional) format.

Parameters:

input - the data and optional metadata which have to be encrypted and integrity-protected

Returns:

the encrypted data

Throws:

JoseException

decrypt

String decrypt(String jwe)
        throws JoseException

Decrypt the encrypted data in the JWE compact or JSON (optional) format.

Parameters:

jwe - the JWE sequence.

Returns:

decrypted data

Throws:

JoseException

decryption

DecryptionOutput decryption(String jwe)
                     throws JoseException

Decrypt the encrypted data in the JWE compact or JSON (optional) format.

Parameters:

jwe - the JWE sequence.

Returns:

decrypted data and verified metadata

Throws:

JoseException