RSA BSAFE Cert-C API Reference

pkcs12.h

Go to the documentation of this file.

/*
* Copyright (c) RSA Security Inc., 1999-2003.  All rights reserved.
* This work contains proprietary, confidential, and trade secret
* information of RSA Security Inc.  Use, disclosure or reproduction
* without the express written authorization of RSA Security Inc. is
* prohibited.
*/


#ifndef HEADER_BSAFE_CERTC_PKCS12
#define HEADER_BSAFE_CERTC_PKCS12 1

#include "certapi.h"
#include "service.h"
#include "certio.h"

#ifdef __cplusplus
extern "C" {
#endif

/*
A PKCS12 bag in PKCS12_CONTENTS has one of the following types.
*/
#define PKCS12_KEY_BAG_TYPE     1
#define PKCS12_CERT_BAG_TYPE    2
#define PKCS12_CRL_BAG_TYPE     3
#define PKCS12_SECRET_BAG_TYPE  4

#define PKCS12_ENCRYPTION_ALGORITHM_COUNT  6
#define PKCS12_DIGEST_ALGORITHM_COUNT      1
#define PKCS12_EXPORT_FORMAT_OPTION_COUNT  2
#define PKCS12_DEFAULT_ITERATIONS          1

#define RC4_128BIT            1
#define RC4_40BIT             2
#define TRIPLE_DES_CBC_3KEY   3
#define TRIPLE_DES_CBC_2KEY   4
#define RC2_CBC_128BIT        5
#define RC2_CBC_40BIT         6

extern const int PKCS12_POSSIBLE_ENCRYPTION_ALGORITHMS
  [PKCS12_ENCRYPTION_ALGORITHM_COUNT];
extern const int PKCS12_POSSIBLE_DIGEST_ALGORITHMS
  [PKCS12_DIGEST_ALGORITHM_COUNT];
extern const int PKCS12_POSSIBLE_EXPORT_FORMAT_OPTIONS
  [PKCS12_EXPORT_FORMAT_OPTION_COUNT];

typedef struct KEY_CONTENT {
  B_KEY_OBJ key;
  CERT_OBJ  cert;
} KEY_CONTENT;

typedef CERT_OBJ CERT_CONTENT;

typedef CRL_OBJ CRL_CONTENT;

typedef struct SECRET_CONTENT {
  ITEM type;
  ITEM value;
} SECRET_CONTENT;

typedef struct PKCS12_BAG {
  int type;
  union  {
    KEY_CONTENT    keyContent;
    CERT_CONTENT   certContent;
    CRL_CONTENT    crlContent;
    SECRET_CONTENT secretContent;
  } content;
  ITEM friendlyName;
} PKCS12_BAG;

extern LIST_OBJ_ENTRY_HANDLER PKCS12BagEntryHandler;

/*
  Various flag values that control importing/exporting a PKCS12 file/
*/

#define PKCS12_NO_MAC_VERIFICATION      0x00000001

#define PKCS12_MS_EXPLORER              0x00000002

#define PKCS12_NS_NAVIGATOR             0x00000004

#define PKCS12_USE_TWO_PASSWORDS        0x00000008

/* When this flag is set, DSA private keys will be encoded in the PKCS #12
   message using the format corresponding to KI_DSAPrivateX957BER, as opposed
   to KI_DSAPrivateBER. */
#define PKCS12_DSA_PRIVATE_X957         0x00000010

int C_ImportPKCS12 (
  CERTC_CTX  ctx,             /* Cert-C context */
  char      *pkcs12fileName,  /* pkcs12 file name */
  ITEM      *macPassword,     /* pkcs12 MAC and possibly encryption password */
  SERVICE    db,              /* database service */
  int        flags,           /* option flags */
  ...);

int C_ReadFromPKCS12 (
  CERTC_CTX  ctx,               /* Cert-C context */
  STREAM     pkcs12Stream,      /* pkcs12 stream */
  ITEM      *macPassword,       /* pkcs12 password */
  int        flags,             /* option flags */
  LIST_OBJ   pkcs12Contents,    /* (out)contents of pkcs12 */
  ...);

int C_ExportPKCS12 (
  CERTC_CTX      ctx,             /* Cert-C context */
  NAME_OBJ       subjectName,     /* identifies cert(s) */
  CERT_PATH_CTX *pathCtx,         /* to build cert chains */
  int            encType,         /* e.g. RC2_CBC_128BIT */
  int            digestType,      /* e.g. DAI_SHA1 */
  int            iterations,      /* MAC iterations */
  int            option,          /* option flags */
  char          *pkcs12fileName,  /* pkcs12 file name */
  ITEM          *macPassword,     /* pkcs12 password */
  ...);

int C_WriteToPKCS12 (
  CERTC_CTX  ctx,             /* Cert-C context */
  LIST_OBJ   pkcs12Contents,  /* contents of pkcs12 file */
  int        encType,         /* e.g. RC2_CBC_128BIT */
  int        digestType,      /* e.g. DAI_SHA1 */
  int        iterations,      /* MAC iterations */
  int        option,          /* option flags */
  ITEM      *macPassword,     /* pkcs12 password */
  STREAM     pkcs12Stream,    /* (out) pkcs12 stream */
  ...);

#ifdef __cplusplus
}
#endif

#endif /* HEADER_BSAFE_CERTC_PKCS12 */

---

RSA BSAFE^® Cert-C 2.7 API Reference