/usr/include/pkcs11-helper-1.0/pkcs11h-openssl.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 | /*
* 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_openssl OpenSSL interface
*
* OpenSSL engine to be used by OpenSSL enabled applications.
*
* @{
*/
/**
* @file pkcs11h-openssl.h
* @brief pkcs11-helper OpenSSL interface.
* @author Alon Bar-Lev <alon.barlev@gmail.com>
* @see pkcs11h_openssl.
*/
#ifndef __PKCS11H_HELPER_H
#define __PKCS11H_HELPER_H
#include <openssl/x509.h>
#include <pkcs11-helper-1.0/pkcs11h-core.h>
#include <pkcs11-helper-1.0/pkcs11h-certificate.h>
#if defined(__cplusplus)
extern "C" {
#endif
/**
* @brief OpenSSL RSA cleanup hook.
* @param certificate Certificate attached to the RSA object.
*/
typedef void (*pkcs11h_hook_openssl_cleanup_t) (
IN const pkcs11h_certificate_t certificate
);
struct pkcs11h_openssl_session_s;
/**
* @brief OpenSSL session reference.
*/
typedef struct pkcs11h_openssl_session_s *pkcs11h_openssl_session_t;
/**
* @brief Returns an X509 object out of the openssl_session object.
* @param certificate Certificate object.
* @return X509.
*/
X509 *
pkcs11h_openssl_getX509 (
IN const pkcs11h_certificate_t certificate
);
/**
* @brief Create OpenSSL session based on a certificate object.
* @param certificate Certificate object.
* @return OpenSSL session reference.
* @note The certificate object will be freed by the OpenSSL interface on session end.
* @see pkcs11h_openssl_freeSession().
*/
pkcs11h_openssl_session_t
pkcs11h_openssl_createSession (
IN const pkcs11h_certificate_t certificate
);
/**
* @brief Sets cleanup hook
* @param openssl_session OpenSSL session reference.
* @return Current hook.
*/
pkcs11h_hook_openssl_cleanup_t
pkcs11h_openssl_getCleanupHook (
IN const pkcs11h_openssl_session_t openssl_session
);
/**
* @brief Sets cleanup hook
* @param openssl_session OpenSSL session reference.
* @param cleanup hook.
*/
void
pkcs11h_openssl_setCleanupHook (
IN const pkcs11h_openssl_session_t openssl_session,
IN const pkcs11h_hook_openssl_cleanup_t cleanup
);
/**
* @brief Free OpenSSL session.
* @param openssl_session OpenSSL session reference.
* @note The openssl_session object has a reference count just like other OpenSSL objects.
*/
void
pkcs11h_openssl_freeSession (
IN const pkcs11h_openssl_session_t openssl_session
);
/**
* @brief Returns an RSA object out of the openssl_session object.
* @param openssl_session OpenSSL session reference.
* @return RSA.
*/
RSA *
pkcs11h_openssl_session_getRSA (
IN const pkcs11h_openssl_session_t openssl_session
);
/**
* @brief Returns an X509 object out of the openssl_session object.
* @param openssl_session OpenSSL session reference.
* @return X509.
*/
X509 *
pkcs11h_openssl_session_getX509 (
IN const pkcs11h_openssl_session_t openssl_session
);
#ifdef __cplusplus
}
#endif
/** @} */
#endif /* __PKCS11H_OPENSSL_H */
|