org.apache.pekko.http.scaladsl.server.directives

Class Credentials.Provided

java.lang.Object

org.apache.pekko.http.scaladsl.server.directives.Credentials.Provided

All Implemented Interfaces:

java.io.Serializable, Credentials, scala.Equals, scala.Product

Enclosing interface:

Credentials

public abstract static class Credentials.Provided
extends java.lang.Object
implements Credentials, scala.Product, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.server.directives.Credentials

Credentials.Missing$, Credentials.Provided, Credentials.Provided$

Constructor Summary

Constructors

Constructor and Description
Provided(java.lang.String identifier)

Method Summary

Modifier and Type	Method and Description
java.lang.String	identifier()
abstract boolean	provideVerify(scala.Function1<java.lang.String,java.lang.Object> verifier) Compares with custom 'verifier' the received secret part of the Credentials.
boolean	provideVerify(java.lang.String secret, scala.Function2<java.lang.String,java.lang.String,java.lang.Object> verifier) Compares with custom 'verifier' and the passed secret with the received secret part of the Credentials.
boolean	verify(java.lang.String secret) Safely compares the passed in secret with the received secret part of the Credentials.
abstract boolean	verify(java.lang.String secret, scala.Function1<java.lang.String,java.lang.String> hasher) First applies the passed in hasher function to the received secret part of the Credentials and then safely compares the passed in secret with the hashed received secret.

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Product

$init$, productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

Provided

public Provided(java.lang.String identifier)

Method Detail

identifier

public java.lang.String identifier()

verify

public abstract boolean verify(java.lang.String secret,
                               scala.Function1<java.lang.String,java.lang.String> hasher)

First applies the passed in hasher function to the received secret part of the Credentials and then safely compares the passed in secret with the hashed received secret. This method can be used if the secret is not stored in plain text. Use of this method instead of manual String equality testing is recommended in order to guard against timing attacks.

See also EnhancedString#secure_==, for more information.

Parameters:

secret - (undocumented)

hasher - (undocumented)

Returns:

(undocumented)

verify

public boolean verify(java.lang.String secret)

Safely compares the passed in secret with the received secret part of the Credentials. Use of this method instead of manual String equality testing is recommended in order to guard against timing attacks.

See also EnhancedString#secure_==, for more information.

Parameters:

secret - (undocumented)

Returns:

(undocumented)

provideVerify

public abstract boolean provideVerify(scala.Function1<java.lang.String,java.lang.Object> verifier)

Compares with custom 'verifier' the received secret part of the Credentials. Use of this method only if custom String equality testing is required, not recommended.

Parameters:

verifier - (undocumented)

Returns:

(undocumented)

provideVerify

public boolean provideVerify(java.lang.String secret,
                             scala.Function2<java.lang.String,java.lang.String,java.lang.Object> verifier)

Compares with custom 'verifier' and the passed secret with the received secret part of the Credentials. Use of this method only if custom String equality testing is required, not recommended.

Parameters:

secret - (undocumented)

verifier - (undocumented)

Returns:

(undocumented)