Package org.keycloak.sdjwt

Class SdJwt

java.lang.Object

org.keycloak.sdjwt.SdJwt

public class SdJwt
extends Object

Main entry class for selective disclosure jwt (SD-JWT).

Author:

Francis Pouatcha

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SdJwt.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_NUMBER_OF_DECOYS

Constructor Summary

Constructors

Constructor	Description
SdJwt(com.fasterxml.jackson.databind.node.ObjectNode claimSet, KeyBindingJWT keyBindingJWT)
SdJwt(com.fasterxml.jackson.databind.node.ObjectNode claimSet, KeyBindingJWT keyBindingJWT, List<SdJwt> nesteSdJwts)
SdJwt(IssuerSignedJWT issuerSignedJWT, KeyBindingJWT keyBindingJWT)
SdJwt(IssuerSignedJWT issuerSignedJWT, KeyBindingJWT keyBindingJWT, List<SdJwt> nesteSdJwts)
SdJwt(IssuerSignedJWT issuerSignedJWT, KeyBindingJWT keyBindingJWT, List<SdJwtClaim> claims, List<String> disclosures)

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	asNestedPayload()	Prepare to a nested payload to this SD-JWT.
static SdJwt.Builder	builder()
List<SdJwtClaim>	getClaims()
List<String>	getDisclosures()
IssuerSignedJWT	getIssuerSignedJWT()
KeyBindingJWT	getKeybindingJwt()
Optional<String>	getSdJwtString()
SdJwtVerificationContext	getSdJwtVerificationContext()
void	setKeybindingJwt(KeyBindingJWT keybindingJwt)
void	setSdJwtString(Optional<String> sdJwtString)
void	setSdJwtVerificationContext(SdJwtVerificationContext sdJwtVerificationContext)
String	toSdJwtString()
String	toString()
void	verify(List<SignatureVerifierContext> issuerVerifyingKeys, IssuerSignedJwtVerificationOpts verificationOpts)	Verifies SD-JWT as to whether the Issuer-signed JWT's signature and disclosures are valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_NUMBER_OF_DECOYS

public static final int DEFAULT_NUMBER_OF_DECOYS

See Also:

• Constant Field Values

Constructor Details

SdJwt

public SdJwt(IssuerSignedJWT issuerSignedJWT,
 KeyBindingJWT keyBindingJWT)

SdJwt

public SdJwt(IssuerSignedJWT issuerSignedJWT,
 KeyBindingJWT keyBindingJWT,
 List<SdJwt> nesteSdJwts)

SdJwt

public SdJwt(com.fasterxml.jackson.databind.node.ObjectNode claimSet,
 KeyBindingJWT keyBindingJWT)

SdJwt

public SdJwt(com.fasterxml.jackson.databind.node.ObjectNode claimSet,
 KeyBindingJWT keyBindingJWT,
 List<SdJwt> nesteSdJwts)

SdJwt

public SdJwt(IssuerSignedJWT issuerSignedJWT,
 KeyBindingJWT keyBindingJWT,
 List<SdJwtClaim> claims,
 List<String> disclosures)

Method Details

asNestedPayload

public com.fasterxml.jackson.databind.JsonNode asNestedPayload()

Prepare to a nested payload to this SD-JWT.

dropping the algo claim.

Returns:

toSdJwtString

public String toSdJwtString()

getKeybindingJwt

public KeyBindingJWT getKeybindingJwt()

setKeybindingJwt

public void setKeybindingJwt(KeyBindingJWT keybindingJwt)

getClaims

public List<SdJwtClaim> getClaims()

getSdJwtVerificationContext

public SdJwtVerificationContext getSdJwtVerificationContext()

setSdJwtVerificationContext

public void setSdJwtVerificationContext(SdJwtVerificationContext sdJwtVerificationContext)

getSdJwtString

public Optional<String> getSdJwtString()

setSdJwtString

public void setSdJwtString(Optional<String> sdJwtString)

toString

public String toString()

Overrides:

toString in class Object

getIssuerSignedJWT

public IssuerSignedJWT getIssuerSignedJWT()

getDisclosures

public List<String> getDisclosures()

verify

public void verify(List<SignatureVerifierContext> issuerVerifyingKeys,
 IssuerSignedJwtVerificationOpts verificationOpts)
            throws VerificationException

Verifies SD-JWT as to whether the Issuer-signed JWT's signature and disclosures are valid.

Parameters:

issuerVerifyingKeys - Verifying keys for validating the Issuer-signed JWT. The caller is responsible for establishing trust in that the keys belong to the intended issuer.

verificationOpts - Options to parameterize the Issuer-Signed JWT verification.

Throws:

VerificationException - if verification failed

builder

public static SdJwt.Builder builder()