globals.h

/* -*- c++ -*- */
#ifndef GLOBALS_H
#define GLOBALS_H
// Copyright 2013-2014 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "pkcs11-env.h"

#include <map>
#include <set>
#include <string>

namespace pkcs11 {
namespace test {

// Set of function pointers holding PKCS#11 implementation.
extern CK_FUNCTION_LIST_PTR g_fns;
// Slot to perform tests against.
extern CK_SLOT_ID g_slot_id;
// Whether to emit verbose information.
extern bool g_verbose;
// Whether to perform tests that require SO login.
extern bool g_so_tests;
// Whether to perform tests that initialize the token.  These wipe any existing
// token contents, so need to be explicitly enabled.
extern bool g_init_token;
// The flags describing the capabilities of the token.
extern CK_FLAGS g_token_flags;
// The token label.
extern CK_UTF8CHAR g_token_label[32];  // blank padded
// User PIN.  Only used if (g_token_flags & CKF_LOGIN_REQUIRED).
extern const char* g_user_pin;
// Security Officer PIN.  Only used if (g_token_flags & CKF_LOGIN_REQUIRED).
extern const char* g_so_pin;
// User PIN after token reset.  Only used if (g_token_flags & CKF_LOGIN_REQUIRED).
extern const char* g_reset_user_pin;
// Security Officer PIN after token reset.  Only used if (g_token_flags & CKF_LOGIN_REQUIRED).
extern const char* g_reset_so_pin;
// The name of the cipher for the wrapped key in wrapping tests.
extern const char* g_wrap_mechanism;

// Algorithm information.  These tables are effectively const, but not marked as
// const so operator[] can be used for convenience.
struct HmacInfo {
  CK_MECHANISM_TYPE hmac;
  CK_ULONG mac_size;
};
extern std::map<std::string, HmacInfo> kHmacInfo;

struct SignatureInfo {
  CK_MECHANISM_TYPE alg;
  int max_data;
};
extern std::map<std::string, SignatureInfo> kSignatureInfo;

struct CipherInfo {
  CK_KEY_TYPE keytype;
  CK_MECHANISM_TYPE keygen;
  CK_MECHANISM_TYPE mode;
  int blocksize;
  bool has_iv;
  int keylen;
};
extern std::map<std::string, CipherInfo> kCipherInfo;

struct DigestInfo {
  CK_MECHANISM_TYPE type;
  int size;
};
extern std::map<std::string, DigestInfo> kDigestInfo;

// PKCS#11 mechanisms for encrypt/decrypt.
extern std::set<CK_MECHANISM_TYPE> encrypt_decrypt_mechanisms;
// PKCS#11 mechanisms for sign/verify.
extern std::set<CK_MECHANISM_TYPE> sign_verify_mechanisms;
// PKCS#11 mechanisms for sign/verify-recover.
extern std::set<CK_MECHANISM_TYPE> sign_verify_recover_mechanisms;
// PKCS#11 mechanisms for digest generation.
extern std::set<CK_MECHANISM_TYPE> digest_mechanisms;
// PKCS#11 mechanisms for key generation.
extern std::set<CK_MECHANISM_TYPE> generate_mechanisms;
// PKCS#11 mechanisms for wrap/unwrap.
extern std::set<CK_MECHANISM_TYPE> wrap_unwrap_mechanisms;
// PKCS#11 mechanisms for derive.
extern std::set<CK_MECHANISM_TYPE> derive_mechanisms;
// PKCS#11 mechanisms for elliptic curve cryptography.
extern std::set<CK_MECHANISM_TYPE> elliptic_curve_mechanisms;

// Global variables for boolean values.  These are useful in object
// attribute lists.
extern CK_BBOOL g_ck_false;
extern CK_BBOOL g_ck_true;
// Label value to use for all test-created objects.  If the test leaves
// the token in a bad state, this label can be used to spot what needs
// cleaning up.
extern const char* g_label;
extern CK_ULONG g_label_len;

}  // namespace test
}  // namespace pkcs11

#endif  // GLOBALS_H