com.nimbusds.openid.connect.sdk.Nonce Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing
client and server applications.
/*
* oauth2-oidc-sdk
*
* Copyright 2012-2016, Connect2id Ltd and contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package com.nimbusds.openid.connect.sdk;
import com.nimbusds.oauth2.sdk.id.Identifier;
import com.nimbusds.oauth2.sdk.util.StringUtils;
import net.jcip.annotations.Immutable;
/**
* Nonce. This is a random, unique string value to associate a user-session
* with an ID Token and to mitigate replay attacks.
*
* Example generation of a nonce with eight random mixed-case alphanumeric
* characters:
*
*
* Nonce nonce = new Nonce(8);
*
*
* Related specifications:
*
*
* - OpenID Connect Core 1.0, section 3.1.2.1. and 15.5.2.
*
*/
@Immutable
public final class Nonce extends Identifier {
/**
* Creates a new nonce with the specified value.
*
* @param value The nonce value. Must not be {@code null} or empty
* string.
*/
public Nonce(final String value) {
super(value);
}
/**
* Creates a new nonce with a randomly generated value of the specified
* byte length, Base64URL-encoded.
*
* @param byteLength The byte length of the value to generate. Must be
* greater than one.
*/
public Nonce(final int byteLength) {
super(byteLength);
}
/**
* Creates a new nonce with a randomly generated 256-bit (32-byte)
* value, Base64URL-encoded.
*/
public Nonce() {
super();
}
@Override
public boolean equals(final Object object) {
return object instanceof Nonce &&
this.toString().equals(object.toString());
}
/**
* Parses a nonce from the specified string.
*
* @param s The string to parse, {@code null} or empty if no nonce is
* specified.
*
* @return The nonce, {@code null} if the parsed string was
* {@code null} or empty.
*/
public static Nonce parse(final String s) {
if (StringUtils.isBlank(s))
return null;
return new Nonce(s);
}
}