/usr/include/pkcs11-helper-1.0/pkcs11h-data.h is in libpkcs11-helper1-dev 1.09-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | /*
* Copyright (c) 2005-2011 Alon Bar-Lev <alon.barlev@gmail.com>
* All rights reserved.
*
* 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.
*/
/**
* @addtogroup pkcs11h_data Data object interface
*
* Data object manipulation.
*
* @{
*/
/**
* @file pkcs11h-data.h
* @brief pkcs11-helper data object support.
* @author Alon Bar-Lev <alon.barlev@gmail.com>
* @see pkcs11h_data.
*/
#ifndef __PKCS11H_DATA_H
#define __PKCS11H_DATA_H
#include <pkcs11-helper-1.0/pkcs11h-core.h>
#if defined(__cplusplus)
extern "C" {
#endif
struct pkcs11h_data_id_list_s;
/**
* @brief Data identifier list.
*/
typedef struct pkcs11h_data_id_list_s *pkcs11h_data_id_list_t;
/**
* @brief Data identifier list.
*/
struct pkcs11h_data_id_list_s {
/** Next element */
pkcs11h_data_id_list_t next;
/** Application string */
char *application;
/** Label string */
char *label;
};
/**
* @brief Get data object.
* @param token_id Token id object.
* @param is_public Object is public.
* @param application Object application attribute.
* @param label Object label attribute.
* @param user_data Optional user data, to be passed to hooks.
* @param mask_prompt Allow prompt @ref PKCS11H_PROMPT_MASK.
* @param blob Blob, set to NULL to get size.
* @param p_blob_size Blob size.
* @return CK_RV.
* @note blob may be NULL to get size.
*/
CK_RV
pkcs11h_data_get (
IN const pkcs11h_token_id_t token_id,
IN const PKCS11H_BOOL is_public,
IN const char * const application,
IN const char * const label,
IN void * const user_data,
IN const unsigned mask_prompt,
OUT unsigned char * const blob,
IN OUT size_t * const p_blob_size
);
/**
* @brief Put data object.
* @param token_id Token id object.
* @param is_public Object is public.
* @param application Object application attribute.
* @param label Object label attribute.
* @param user_data Optional user data, to be passed to hooks.
* @param mask_prompt Allow prompt @ref PKCS11H_PROMPT_MASK.
* @param blob Blob, set to NULL to get size.
* @param blob_size Blob size.
* @return CK_RV.
*/
CK_RV
pkcs11h_data_put (
IN const pkcs11h_token_id_t token_id,
IN const PKCS11H_BOOL is_public,
IN const char * const application,
IN const char * const label,
IN void * const user_data,
IN const unsigned mask_prompt,
OUT unsigned char * const blob,
IN const size_t blob_size
);
/**
* @brief Delete data object.
* @param token_id Token id object.
* @param is_public Object is public.
* @param application Object application attribute.
* @param label Object label attribute.
* @param user_data Optional user data, to be passed to hooks.
* @param mask_prompt Allow prompt @ref PKCS11H_PROMPT_MASK.
* @return CK_RV.
*/
CK_RV
pkcs11h_data_del (
IN const pkcs11h_token_id_t token_id,
IN const PKCS11H_BOOL is_public,
IN const char * const application,
IN const char * const label,
IN void * const user_data,
IN const unsigned mask_prompt
);
/**
* @brief Free data object list.
* @param data_id_list List to free.
* @return CK_RV.
*/
CK_RV
pkcs11h_data_freeDataIdList (
IN const pkcs11h_data_id_list_t data_id_list
);
/**
* @brief Get list of data objects.
* @param token_id Token id object.
* @param is_public Get a list of public objects.
* @param user_data Optional user data, to be passed to hooks.
* @param mask_prompt Allow prompt @ref PKCS11H_PROMPT_MASK.
* @param p_data_id_list List location.
* @see pkcs11h_data_freeDataIdList().
* @return CK_RV.
*/
CK_RV
pkcs11h_data_enumDataObjects (
IN const pkcs11h_token_id_t token_id,
IN const PKCS11H_BOOL is_public,
IN void * const user_data,
IN const unsigned mask_prompt,
OUT pkcs11h_data_id_list_t * const p_data_id_list
);
#ifdef __cplusplus
}
#endif
/** @} */
#endif /* __PKCS11H_DATA_H */
|