Package com.yubico.webauthn.data

Class RelyingPartyIdentity

java.lang.Object

com.yubico.webauthn.data.RelyingPartyIdentity

All Implemented Interfaces:

PublicKeyCredentialEntity

public final class RelyingPartyIdentity
extends java.lang.Object
implements PublicKeyCredentialEntity

Used to supply additional Relying Party attributes when creating a new credential.

See Also:

§5.4.2. Relying Party Parameters for Credential Generation (dictionary PublicKeyCredentialRpEntity)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelyingPartyIdentity.RelyingPartyIdentityBuilder

Method Summary

Modifier and Type	Method	Description
static RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages	builder()
boolean	equals(java.lang.Object o)
java.util.Optional<java.net.URL>	getIcon()	Deprecated. The icon property has been removed from WebAuthn Level 2.
@NonNull java.lang.String	getId()	A unique identifier for the Relying Party, which sets the RP ID.
@NonNull java.lang.String	getName()	The human-palatable name of the Relaying Party.
int	hashCode()
RelyingPartyIdentity.RelyingPartyIdentityBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages builder()

getIcon

@Deprecated
public java.util.Optional<java.net.URL> getIcon()

Deprecated.

The icon property has been removed from WebAuthn Level 2. This method will be removed in the next major version of the library.

Description copied from interface: PublicKeyCredentialEntity

A serialized URL which resolves to an image associated with the entity.

For example, this could be a user's avatar or a Relying Party's logo. This URL MUST be an a priori authenticated URL. Authenticators MUST accept and store a 128-byte minimum length for an icon member's value. Authenticators MAY ignore an icon member's value if its length is greater than 128 bytes. The URL's scheme MAY be "data" to avoid fetches of the URL, at the cost of needing more storage.

Specified by:

getIcon in interface PublicKeyCredentialEntity

toBuilder

public RelyingPartyIdentity.RelyingPartyIdentityBuilder toBuilder()

getId

@NonNull
public @NonNull java.lang.String getId()

A unique identifier for the Relying Party, which sets the RP ID.

This defines the domains where users' credentials are valid. See RP ID: scope for details and examples.

See Also:

RP ID, RP ID: scope

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

@NonNull
public @NonNull java.lang.String getName()

The human-palatable name of the Relaying Party.

For example: "ACME Corporation", "Wonderful Widgets, Inc." or "ОАО Примертех".

Specified by:

getName in interface PublicKeyCredentialEntity

See Also:

RFC 8264, RFC 8265