lib/fko.h

   1 /*
   2  *****************************************************************************
   3  *
   4  * File:    fko.h
   5  *
   6  * Author:  Damien S. Stuart
   7  *
   8  * Purpose: Header for libfko.
   9  *
  10  * Copyright 2009-2010 Damien Stuart (dstuart@dstuart.org)
  11  *
  12  *  License (GNU Public License):
  13  *
  14  *  This program is free software; you can redistribute it and/or
  15  *  modify it under the terms of the GNU General Public License
  16  *  as published by the Free Software Foundation; either version 2
  17  *  of the License, or (at your option) any later version.
  18  *
  19  *  This program is distributed in the hope that it will be useful,
  20  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  *  GNU General Public License for more details.
  23  *
  24  *  You should have received a copy of the GNU General Public License
  25  *  along with this program; if not, write to the Free Software
  26  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  27  *  USA
  28  *
  29  *****************************************************************************
  30 */
  31 #ifndef FKO_H
  32 #define FKO_H 1
  33
  34 #include <time.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 #ifdef WIN32
  41   #ifdef DLL_EXPORTS
  42     #define DLL_API __declspec(dllexport)
  43   #else
  44         #ifdef DLL_IMPORTS
  45                 #define DLL_API __declspec(dllimport)
  46         #else
  47                 #define DLL_API
  48         #endif
  49   #endif
  50 #else
  51   #define DLL_API
  52 #endif
  53
  54 /* General params
  55 */
  56 #define FKO_PROTOCOL_VERSION "1.9.12" /* The fwknop protocol version */
  57
  58 /* Supported FKO Message types...
  59 */
  60 typedef enum {
  61     FKO_COMMAND_MSG = 0,
  62     FKO_ACCESS_MSG,
  63     FKO_NAT_ACCESS_MSG,
  64     FKO_CLIENT_TIMEOUT_ACCESS_MSG,
  65     FKO_CLIENT_TIMEOUT_NAT_ACCESS_MSG,
  66     FKO_LOCAL_NAT_ACCESS_MSG,
  67     FKO_CLIENT_TIMEOUT_LOCAL_NAT_ACCESS_MSG,
  68     FKO_LAST_MSG_TYPE /* Always leave this as the last one */
  69 } fko_message_type_t;
  70
  71 /* Supported digest types...
  72 */
  73 typedef enum {
  74     FKO_DIGEST_INVALID_DATA = -1,
  75     FKO_DIGEST_UNKNOWN = 0,
  76     FKO_DIGEST_MD5,
  77     FKO_DIGEST_SHA1,
  78     FKO_DIGEST_SHA256,
  79     FKO_DIGEST_SHA384,
  80     FKO_DIGEST_SHA512,
  81     FKO_LAST_DIGEST_TYPE /* Always leave this as the last one */
  82 } fko_digest_type_t;
  83
  84 /* Supported encryption types...
  85 */
  86 typedef enum {
  87     FKO_ENCRYPTION_INVALID_DATA = -1,
  88     FKO_ENCRYPTION_UNKNOWN = 0,
  89     FKO_ENCRYPTION_RIJNDAEL,
  90     FKO_ENCRYPTION_GPG,
  91     FKO_LAST_ENCRYPTION_TYPE /* Always leave this as the last one */
  92 } fko_encryption_type_t;
  93
  94 /* FKO ERROR_CODES
  95  *
  96  * Note: If you change this list in any way, please be sure to make the
  97  *       appropriate corresponding change to the error message list in
  98  *       fko_error.c.
  99 */
 100 typedef enum {
 101     FKO_SUCCESS = 0,
 102     FKO_ERROR_CTX_NOT_INITIALIZED,
 103     FKO_ERROR_MEMORY_ALLOCATION,
 104     FKO_ERROR_FILESYSTEM_OPERATION,
 105     FKO_ERROR_INVALID_DATA,
 106     FKO_ERROR_DATA_TOO_LARGE,
 107     FKO_ERROR_USERNAME_UNKNOWN,
 108     FKO_ERROR_INCOMPLETE_SPA_DATA,
 109     FKO_ERROR_MISSING_ENCODED_DATA,
 110     FKO_ERROR_INVALID_DIGEST_TYPE,
 111     FKO_ERROR_INVALID_ALLOW_IP,
 112     FKO_ERROR_INVALID_SPA_COMMAND_MSG,
 113     FKO_ERROR_INVALID_SPA_ACCESS_MSG,
 114     FKO_ERROR_INVALID_SPA_NAT_ACCESS_MSG,
 115     FKO_ERROR_INVALID_ENCRYPTION_TYPE,
 116     FKO_ERROR_WRONG_ENCRYPTION_TYPE,
 117     FKO_ERROR_DECRYPTION_SIZE,
 118     FKO_ERROR_DECRYPTION_FAILURE,
 119     FKO_ERROR_DIGEST_VERIFICATION_FAILED,
 120     FKO_ERROR_UNSUPPORTED_FEATURE,
 121     FKO_ERROR_UNKNOWN,
 122
 123     /* Start GPGME-related errors */
 124     GPGME_ERR_START,
 125     FKO_ERROR_MISSING_GPG_KEY_DATA,
 126     FKO_ERROR_GPGME_NO_OPENPGP,
 127     FKO_ERROR_GPGME_CONTEXT,
 128     FKO_ERROR_GPGME_PLAINTEXT_DATA_OBJ,
 129     FKO_ERROR_GPGME_SET_PROTOCOL,
 130     FKO_ERROR_GPGME_CIPHER_DATA_OBJ,
 131     FKO_ERROR_GPGME_BAD_PASSPHRASE,
 132     FKO_ERROR_GPGME_ENCRYPT_SIGN,
 133     FKO_ERROR_GPGME_CONTEXT_SIGNER_KEY,
 134     FKO_ERROR_GPGME_SIGNER_KEYLIST_START,
 135     FKO_ERROR_GPGME_SIGNER_KEY_NOT_FOUND,
 136     FKO_ERROR_GPGME_SIGNER_KEY_AMBIGUOUS,
 137     FKO_ERROR_GPGME_ADD_SIGNER,
 138     FKO_ERROR_GPGME_CONTEXT_RECIPIENT_KEY,
 139     FKO_ERROR_GPGME_RECIPIENT_KEYLIST_START,
 140     FKO_ERROR_GPGME_RECIPIENT_KEY_NOT_FOUND,
 141     FKO_ERROR_GPGME_RECIPIENT_KEY_AMBIGUOUS,
 142     FKO_ERROR_GPGME_DECRYPT_FAILED,
 143     FKO_ERROR_GPGME_DECRYPT_UNSUPPORTED_ALGORITHM,
 144     FKO_ERROR_GPGME_BAD_GPG_EXE,
 145     FKO_ERROR_GPGME_BAD_HOME_DIR,
 146     FKO_ERROR_GPGME_SET_HOME_DIR,
 147     FKO_ERROR_GPGME_NO_SIGNATURE,
 148     FKO_ERROR_GPGME_BAD_SIGNATURE,
 149     FKO_ERROR_GPGME_SIGNATURE_VERIFY_DISABLED,
 150
 151     FKO_LAST_ERROR
 152 } fko_error_codes_t;
 153
 154 /* Macro that returns true if the given error code is a gpg-related error.
 155 */
 156 #define IS_GPG_ERROR(x) (x > GPGME_ERR_START && x < FKO_LAST_ERROR)
 157
 158 /* General Defaults
 159 */
 160 #define FKO_DEFAULT_MSG_TYPE    FKO_ACCESS_MSG
 161 #define FKO_DEFAULT_DIGEST      FKO_DIGEST_SHA256
 162 #define FKO_DEFAULT_ENCRYPTION  FKO_ENCRYPTION_RIJNDAEL
 163
 164 /* The context holds the global state and config options, as
 165  * well as some intermediate results during processing. This
 166  * is an opaque pointer.
 167 */
 168 struct fko_context;
 169 typedef struct fko_context *fko_ctx_t;
 170
 171 /* Some gpg-specifc data types and constants.
 172 */
 173 #if HAVE_LIBGPGME
 174
 175 enum {
 176     FKO_GPG_NO_SIG_VERIFY_SIGS  = 0x01,
 177     FKO_GPG_ALLOW_BAD_SIG       = 0x02,
 178     FKO_GPG_NO_SIG_INFO         = 0x04,
 179     FKO_GPG_ALLOW_EXPIRED_SIG   = 0x08,
 180     FKO_GPG_ALLOW_REVOKED_SIG   = 0x10
 181 };
 182
 183 #define FKO_GPG_GOOD_SIGSUM     3
 184
 185 #endif /* HAVE_LIBGPGME */
 186
 187 /* Function prototypes */
 188
 189 /* General api calls
 190 */
 191 DLL_API int fko_new(fko_ctx_t *ctx);
 192 DLL_API int fko_new_with_data(fko_ctx_t *ctx, const char *enc_msg, const char *dec_key);
 193 DLL_API void fko_destroy(fko_ctx_t ctx);
 194 DLL_API int fko_spa_data_final(fko_ctx_t ctx, const char *enc_key);
 195
 196
 197 /* Set context data functions
 198 */
 199 DLL_API int fko_set_rand_value(fko_ctx_t ctx, const char *val);
 200 DLL_API int fko_set_username(fko_ctx_t ctx, const char *spoof_user);
 201 DLL_API int fko_set_timestamp(fko_ctx_t ctx, const int offset);
 202 DLL_API int fko_set_spa_message_type(fko_ctx_t ctx, const short msg_type);
 203 DLL_API int fko_set_spa_message(fko_ctx_t ctx, const char *msg_string);
 204 DLL_API int fko_set_spa_nat_access(fko_ctx_t ctx, const char *nat_access);
 205 DLL_API int fko_set_spa_server_auth(fko_ctx_t ctx, const char *server_auth);
 206 DLL_API int fko_set_spa_client_timeout(fko_ctx_t ctx, const int timeout);
 207 DLL_API int fko_set_spa_digest_type(fko_ctx_t ctx, const short digest_type);
 208 DLL_API int fko_set_spa_digest(fko_ctx_t ctx);
 209 DLL_API int fko_set_spa_encryption_type(fko_ctx_t ctx, const short encrypt_type);
 210 DLL_API int fko_set_spa_data(fko_ctx_t ctx, const char *enc_msg);
 211
 212 /* Data processing and misc utility functions
 213 */
 214 DLL_API const char* fko_errstr(const int err_code);
 215 DLL_API int fko_encryption_type(const char *enc_data);
 216
 217 DLL_API int fko_encode_spa_data(fko_ctx_t ctx);
 218 DLL_API int fko_decode_spa_data(fko_ctx_t ctx);
 219 DLL_API int fko_encrypt_spa_data(fko_ctx_t ctx, const char *enc_key);
 220 DLL_API int fko_decrypt_spa_data(fko_ctx_t ctx, const char *dec_key);
 221
 222 DLL_API int fko_get_encoded_data(fko_ctx_t ctx, char **enc_data);
 223
 224
 225 /* Get context data functions
 226 */
 227 DLL_API int fko_get_rand_value(fko_ctx_t ctx, char **rand_val);
 228 DLL_API int fko_get_username(fko_ctx_t ctx, char **username);
 229 DLL_API int fko_get_timestamp(fko_ctx_t ctx, time_t *ts);
 230 DLL_API int fko_get_spa_message_type(fko_ctx_t ctx, short *spa_msg);
 231 DLL_API int fko_get_spa_message(fko_ctx_t ctx, char **spa_message);
 232 DLL_API int fko_get_spa_nat_access(fko_ctx_t ctx, char **nat_access);
 233 DLL_API int fko_get_spa_server_auth(fko_ctx_t ctx, char **server_auth);
 234 DLL_API int fko_get_spa_client_timeout(fko_ctx_t ctx, int *client_timeout);
 235 DLL_API int fko_get_spa_digest_type(fko_ctx_t ctx, short *spa_digest_type);
 236 DLL_API int fko_get_spa_digest(fko_ctx_t ctx, char **spa_digest);
 237 DLL_API int fko_get_spa_encryption_type(fko_ctx_t ctx, short *spa_enc_type);
 238 DLL_API int fko_get_spa_data(fko_ctx_t ctx, char **spa_data);
 239
 240 DLL_API int fko_get_version(fko_ctx_t ctx, char **version);
 241
 242 /* GPG-related functions */
 243 DLL_API int fko_set_gpg_exe(fko_ctx_t ctx, const char *gpg_exe);
 244 DLL_API int fko_get_gpg_exe(fko_ctx_t ctx, char **gpg_exe);
 245
 246 DLL_API int fko_set_gpg_recipient(fko_ctx_t ctx, const char *recip);
 247 DLL_API int fko_get_gpg_recipient(fko_ctx_t ctx, char **recip);
 248 DLL_API int fko_set_gpg_signer(fko_ctx_t ctx, const char *signer);
 249 DLL_API int fko_get_gpg_signer(fko_ctx_t ctx, char **signer);
 250 DLL_API int fko_set_gpg_home_dir(fko_ctx_t ctx, const char *gpg_home_dir);
 251 DLL_API int fko_get_gpg_home_dir(fko_ctx_t ctx, char **gpg_home_dir);
 252
 253 DLL_API const char* fko_gpg_errstr(fko_ctx_t ctx);
 254
 255 DLL_API int fko_set_gpg_signature_verify(fko_ctx_t ctx, const unsigned char val);
 256 DLL_API int fko_get_gpg_signature_verify(fko_ctx_t ctx, unsigned char *val);
 257 DLL_API int fko_set_gpg_ignore_verify_error(fko_ctx_t ctx, const unsigned char val);
 258 DLL_API int fko_get_gpg_ignore_verify_error(fko_ctx_t ctx, unsigned char *val);
 259
 260 DLL_API int fko_get_gpg_signature_id(fko_ctx_t ctx, char **sig_id);
 261 DLL_API int fko_get_gpg_signature_fpr(fko_ctx_t ctx, char **sig_fpr);
 262 DLL_API int fko_get_gpg_signature_summary(fko_ctx_t ctx, int *sigsum);
 263 DLL_API int fko_get_gpg_signature_status(fko_ctx_t ctx, int *sigstat);
 264
 265 DLL_API int fko_gpg_signature_id_match(fko_ctx_t ctx, const char *id, unsigned char *result);
 266 DLL_API int fko_gpg_signature_fpr_match(fko_ctx_t ctx, const char *fpr, unsigned char *result);
 267
 268 #ifdef __cplusplus
 269 }
 270 #endif
 271
 272 #endif /* FKO_H */
 273
 274 /***EOF***/