com.nimbusds.openid.connect.sdk.claims.AMR Maven / Gradle / Ivy

/*
 * 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.claims;


import net.jcip.annotations.Immutable;

import com.nimbusds.oauth2.sdk.id.Identifier;


/**
 * Authentication Method Reference ({@code amr}). It identifies the method
 * used in authentication.
 *
 * The AMR is represented by a string or an URI string.
 *
 * 
Related specifications:
 *
 * 

 *     OpenID Connect Core 1.0, section 2.
 * 
 */
@Immutable
public final class AMR extends Identifier {


	/**
	 * Retina scan biometric.
	 */
	public static final AMR EYE = new AMR("eye");


	/**
	 * Fingerprint biometric.
	 */
	public static final AMR FPT = new AMR("fpt");


	/**
	 * Knowledge-based authentication (see NIST.800-63-2).
	 */
	public static final AMR KBA = new AMR("kba");


	/**
	 * Multiple-channel authentication. The authentication involves
	 * communication over more than one distinct channel.
	 */
	public static final AMR MCA = new AMR("mca");


	/**
	 * Multiple-factor authentication (see NIST.800-63-2). When this is
	 * present, specific authentication methods used may also be included.
	 */
	public static final AMR MFA = new AMR("mfa");


	/**
	 * One-time password. One-time password specifications that this
	 * authentication method applies to include RFC 4226 and RFC 6238.
	 */
	public static final AMR OTP = new AMR("otp");


	/**
	 * Proof-of-possession (PoP) of a key. See Appendix C of RFC 4211 for a
	 * discussion on PoP.
	 */
	public static final AMR POP = new AMR("pop");


	/**
	 * Password-based authentication.
	 */
	public static final AMR PWD = new AMR("pwd");


	/**
	 * Risk-based authentication. See Enhanced
	 * Authentication In Online Banking, Journal of Economic Crime
	 * Management 4.2: 18-19, 2006.
	 */
	public static final AMR RBA = new AMR("rba");


	/**
	 * Smart card.
	 */
	public static final AMR SC = new AMR("sc");


	/**
	 * Confirmation by SMS reply.
	 */
	public static final AMR SMS = new AMR("sms");


	/**
	 * Confirmation by telephone call.
	 */
	public static final AMR TEL = new AMR("tel");


	/**
	 * User presence test.
	 */
	public static final AMR USER = new AMR("user");


	/**
	 * Voice biometric.
	 */
	public static final AMR VBM = new AMR("vbm");


	/**
	 * Windows integrated authentication. See
	 * Integrated
	 * Windows Authentication with Negotiate, September 2011.
	 */
	public static final AMR WIA = new AMR("wia");


	
	/**
	 * Creates a new Authentication Method Reference (AMR) with the
	 * specified value.
	 *
	 * @param value The AMR value. Must not be {@code null}.
	 */
	public AMR(final String value) {

		super(value);
	}


	@Override
	public boolean equals(final Object object) {

		return object instanceof AMR &&
		       this.toString().equals(object.toString());
	}
}