pkcs11h-token.h
Go to the documentation of this file.
/*
* Copyright (c) 2005-2018 Alon Bar-Lev <alon.barlev@gmail.com>
*
* This software is available to you under a choice of one of two
* licenses. You may choose to be licensed under the terms of the GNU
* General Public License (GPL) Version 2, or the BSD license.
*
* GNU General Public License (GPL) Version 2
* ===========================================
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program (see the file COPYING.GPL included with this
* distribution); if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* BSD License
* ============
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* o 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.
* o Neither the name of the Alon Bar-Lev nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* 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 __PKCS11H_TOKEN_H
#define __PKCS11H_TOKEN_H
#include <pkcs11-helper-1.0/pkcs11h-core.h>
#if defined(__cplusplus)
extern "C" {
#endif
struct pkcs11h_token_id_list_s;
typedef struct pkcs11h_token_id_list_s *pkcs11h_token_id_list_t;
struct pkcs11h_token_id_list_s {
pkcs11h_token_id_list_t next;
pkcs11h_token_id_t token_id;
};
CK_RV
pkcs11h_token_freeTokenId (
IN pkcs11h_token_id_t token_id
);
CK_RV
pkcs11h_token_duplicateTokenId (
OUT pkcs11h_token_id_t * const to,
IN const pkcs11h_token_id_t from
);
PKCS11H_BOOL
pkcs11h_token_sameTokenId (
IN const pkcs11h_token_id_t a,
IN const pkcs11h_token_id_t b
);
CK_RV
pkcs11h_token_logout (
IN const pkcs11h_token_id_t token_id
);
CK_RV
pkcs11h_token_login (
IN const pkcs11h_token_id_t token_id,
IN const PKCS11H_BOOL readonly,
IN const char * const pin
);
CK_RV
pkcs11h_token_ensureAccess (
IN const pkcs11h_token_id_t token_id,
IN void * const user_data,
IN const unsigned mask_prompt
);
CK_RV
pkcs11h_token_freeTokenIdList (
IN const pkcs11h_token_id_list_t token_id_list
);
CK_RV
pkcs11h_token_enumTokenIds (
IN const unsigned method,
OUT pkcs11h_token_id_list_t * const p_token_id_list
);
CK_RV
pkcs11h_token_serializeTokenId (
OUT char * const sz,
IN OUT size_t *max,
IN const pkcs11h_token_id_t token_id
);
CK_RV
pkcs11h_token_deserializeTokenId (
OUT pkcs11h_token_id_t *p_token_id,
IN const char * const sz
);
#ifdef __cplusplus
}
#endif
#endif /* __PKCS11H_TOKEN_H */
pkcs11h_token_id_t
struct pkcs11h_token_id_s * pkcs11h_token_id_t
Token identifier.
Definition pkcs11h-core.h:406
pkcs11h_token_enumTokenIds
CK_RV pkcs11h_token_enumTokenIds(IN const unsigned method, OUT pkcs11h_token_id_list_t *const p_token_id_list)
Enumerate available tokens.
pkcs11h_token_duplicateTokenId
CK_RV pkcs11h_token_duplicateTokenId(OUT pkcs11h_token_id_t *const to, IN const pkcs11h_token_id_t from)
Duplicate token_id object.
pkcs11h_token_login
CK_RV pkcs11h_token_login(IN const pkcs11h_token_id_t token_id, IN const PKCS11H_BOOL readonly, IN const char *const pin)
Force login, avoid hooks.
pkcs11h_token_sameTokenId
PKCS11H_BOOL pkcs11h_token_sameTokenId(IN const pkcs11h_token_id_t a, IN const pkcs11h_token_id_t b)
Returns TRUE if same token id.
pkcs11h_token_logout
CK_RV pkcs11h_token_logout(IN const pkcs11h_token_id_t token_id)
Force logout.
pkcs11h_token_freeTokenIdList
CK_RV pkcs11h_token_freeTokenIdList(IN const pkcs11h_token_id_list_t token_id_list)
Free certificate_id list.
pkcs11h_token_serializeTokenId
CK_RV pkcs11h_token_serializeTokenId(OUT char *const sz, IN OUT size_t *max, IN const pkcs11h_token_id_t token_id)
Serialize token_id into string.
pkcs11h_token_deserializeTokenId
CK_RV pkcs11h_token_deserializeTokenId(OUT pkcs11h_token_id_t *p_token_id, IN const char *const sz)
Deserialize token_id from string.
pkcs11h_token_ensureAccess
CK_RV pkcs11h_token_ensureAccess(IN const pkcs11h_token_id_t token_id, IN void *const user_data, IN const unsigned mask_prompt)
Ensure token is accessible.
pkcs11h_token_id_list_t
struct pkcs11h_token_id_list_s * pkcs11h_token_id_list_t
Token identifier list.
Definition pkcs11h-token.h:80
pkcs11h_token_freeTokenId
CK_RV pkcs11h_token_freeTokenId(IN pkcs11h_token_id_t token_id)
Free token_id object.
pkcs11h-core.h
pkcs11-helper core.
pkcs11h_token_id_list_s
Token identifier list.
Definition pkcs11h-token.h:85
pkcs11h_token_id_list_s::token_id
pkcs11h_token_id_t token_id
Definition pkcs11h-token.h:89
pkcs11h_token_id_list_s::next
pkcs11h_token_id_list_t next
Definition pkcs11h-token.h:87

pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev@gmail.com> |