com.yubico.client.v2.YubicoResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yubico-validation-client2 Show documentation

Client library written in Java for verifying Yubikey one-time passwords (OTPs) with validation protocol 2.

There is a newer version: 3.1.0

Show newest version

/* Copyright (c) 2011, Linus Widströmer.  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.
 
   Written by Linus Widströmer , January 2011.
*/

package com.yubico.client.v2;

import java.util.Map;

/**
 * Object built from server response, detailing the status of validation.
 *
 */
public interface YubicoResponse {
	
	/**
	 * Signature of the response, with the same API key as the request.
	 * 
	 * @return response signature
	 */
    String getH();
    
    /**
     * UTC timestamp from the server when response was processed.
     * 
     * @return server UTC timestamp
     */
    String getT();
    
    /**
     * Server response to the request.
     * 
     * @see YubicoResponseStatus
     * @return response status
     */
    YubicoResponseStatus getStatus();
    
    /**
     * Returns the internal timestamp from the YubiKey 8hz timer.
     * 
     * @return yubikey internal timestamp
     */
    String getTimestamp();
    
    /**
     * Returns the non-volatile counter that is incremented on power-up.
     * 
     * @return session counter
     */
    String getSessioncounter();
    
    /**
     * Returns the volatile counter that is incremented on each button-press,
     * starts at 0 after power-up.
     * 
     * @return session use counter
     */
    String getSessionuse();
    
    /**
     * Returns the amount of sync the server achieved before sending the
     * response.
     * 
     * @return sync, in procent
     */
    String getSl();
    
    /**
     * Echos back the OTP from the request, should match.
     * 
     * @return otp
     */
    String getOtp();
    
    /**
     * Echos back the nonce from the request. Should match. 
     * @return nonce
     */
    public String getNonce();
    
    /**
     * Returns all parameters from the response as a Map
     * 
     * @return map of all values
     */
    public Map getKeyValueMap();
}