com.yubico.jaas.YubikeyToUserMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yubico-jaas-module Show documentation

JAAS module for verifying YubiKey OTPs

There is a newer version: 3.1.0

/**
 * Copyright (c) 2011, Yubico AB.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 *  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 *  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 *  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 *  THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 */
package com.yubico.jaas;

import java.util.Map;

/**
 * Interface to verify relationship between a username and a YubiKey.
 * Classes implementing this interface MUST have a nullary constructor
 * for {@link java.lang.Class#newInstance()} to work.
 *
 * @author Fredrik Thulin ([email protected])
 *
 */
public interface YubikeyToUserMap {

	/*
	 * Verify that there is a known connection between username and publicId.
	 * If auto-provisioning is enabled and no connection is found, one is registered.
	 *
	 * @param username username to match to YubiKey id
	 * @publicId modhex encoded public id of a YubiKey (e.g. "vvcccccfhc")
	 *
	 */
    public boolean is_right_user(String username, String publicId);
	
	/**
     * Sets configuration options received from JAAS.
     *
	 * @param options  Configuration options
	 */
    public void setOptions(Map options);
}