/* ykclient.h --- Prototypes for Yubikey OTP validation client library.
 *
 * Written by Simon Josefsson <simon@josefsson.org>.
 * Copyright (c) 2006-2013 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.
 *
 */

#ifndef YKCLIENT_H
#define YKCLIENT_H

#include <stdint.h>
#include <string.h>

#include <ykclient_errors.h>
#include <ykclient_version.h>
#include <ykclient_server_response.h>

#define DEFAULT_MAX_RETRIES 3

#ifdef __cplusplus
extern "C"
{
#endif

/* Must be called successfully before using any other functions. */
  extern ykclient_rc ykclient_global_init (void);
  extern void ykclient_global_done (void);

  typedef struct ykclient_st ykclient_t;

  typedef struct ykclient_handle_st ykclient_handle_t;

  extern ykclient_rc ykclient_init (ykclient_t ** ykc);

  extern void ykclient_done (ykclient_t ** ykc);

  extern ykclient_rc ykclient_handle_init (ykclient_t * ykc,
					   ykclient_handle_t ** ykh);

  extern void ykclient_handle_cleanup (ykclient_handle_t * ykh);

  extern void ykclient_handle_done (ykclient_handle_t ** ykh);

/* If value is 0 the authenticity of the signature returned by the
   server in response to the request won't be verified. */
  extern void ykclient_set_verify_signature (ykclient_t * ykc, int value);

  extern const char *ykclient_strerror (ykclient_rc ret);

  extern void ykclient_set_client (ykclient_t * ykc,
				   unsigned int client_id,
				   size_t keylen, const char *key);

  extern ykclient_rc ykclient_set_client_hex (ykclient_t * ykc,
					      unsigned int client_id,
					      const char *key);

  extern ykclient_rc ykclient_set_client_b64 (ykclient_t * ykc,
					      unsigned int client_id,
					      const char *key);

  extern ykclient_rc ykclient_set_url_template (ykclient_t * ykc,
						const char *url_template);

  extern ykclient_rc ykclient_set_url_templates (ykclient_t * ykc,
						 size_t num_templates,
						 const char **url_templates);

  extern ykclient_rc ykclient_set_url_bases (ykclient_t * ykc,
					     size_t num_templates,
					     const char **url_templates);

  extern void ykclient_set_ca_path (ykclient_t * ykc, const char *ca_path);

  extern void ykclient_set_ca_info (ykclient_t * ykc, const char *ca_info);

  extern void ykclient_set_proxy (ykclient_t * ykc, const char *proxy);

/*
 * Set the nonce. A default nonce is generated in ykclient_init(), but
 * if you either want to specify your own nonce, or want to remove the
 * nonce (needed to send signed requests to v1 validation servers),
 * you must call this function. Set nonce to NULL to disable it.
 */
  extern void ykclient_set_nonce (ykclient_t * ykc, char *nonce);

  extern void ykclient_set_max_retries (ykclient_t * ykc, int retries);


  extern const char *ykclient_get_last_url (ykclient_t * ykc);

  extern ykclient_rc ykclient_request_process (ykclient_t * ykc,
					       ykclient_handle_t * ykh,
					       const char *yubikey);

  extern ykclient_rc ykclient_request (ykclient_t * ykc,
				       const char *yubikey_otp);

/* One call interface for validation protocol 1.x, with default URL. */
  extern ykclient_rc ykclient_verify_otp (const char *yubikey_otp,
					  unsigned int client_id,
					  const char *hexkey);

/* One call interface for validation protocol 2.0 and/or non-default URL. */
  extern ykclient_rc ykclient_verify_otp_v2 (ykclient_t * ykc_in,
					     const char *yubikey_otp,
					     unsigned int client_id,
					     const char *hexkey,
					     size_t urlcount,
					     const char **urls,
					     const char *api_key);

/* Fetch out the server response form the last query */
  extern const ykclient_server_response_t *ykclient_get_server_response(ykclient_t *ykc);
#ifdef __cplusplus
}
#endif

#endif