/gecko_api/include/seccomon.h

  1/* ***** BEGIN LICENSE BLOCK *****
  2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3 *
  4 * The contents of this file are subject to the Mozilla Public License Version
  5 * 1.1 (the "License"); you may not use this file except in compliance with
  6 * the License. You may obtain a copy of the License at
  7 * http://www.mozilla.org/MPL/
  8 *
  9 * Software distributed under the License is distributed on an "AS IS" basis,
 10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 11 * for the specific language governing rights and limitations under the
 12 * License.
 13 *
 14 * The Original Code is the Netscape security libraries.
 15 *
 16 * The Initial Developer of the Original Code is
 17 * Netscape Communications Corporation.
 18 * Portions created by the Initial Developer are Copyright (C) 1994-2000
 19 * the Initial Developer. All Rights Reserved.
 20 *
 21 * Contributor(s):
 22 *
 23 * Alternatively, the contents of this file may be used under the terms of
 24 * either the GNU General Public License Version 2 or later (the "GPL"), or
 25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 26 * in which case the provisions of the GPL or the LGPL are applicable instead
 27 * of those above. If you wish to allow use of your version of this file only
 28 * under the terms of either the GPL or the LGPL, and not to allow others to
 29 * use your version of this file under the terms of the MPL, indicate your
 30 * decision by deleting the provisions above and replace them with the notice
 31 * and other provisions required by the GPL or the LGPL. If you do not delete
 32 * the provisions above, a recipient may use your version of this file under
 33 * the terms of any one of the MPL, the GPL or the LGPL.
 34 *
 35 * ***** END LICENSE BLOCK ***** */
 36
 37/*
 38 * seccomon.h - common data structures for security libraries
 39 *
 40 * This file should have lowest-common-denominator datastructures
 41 * for security libraries.  It should not be dependent on any other
 42 * headers, and should not require linking with any libraries.
 43 *
 44 * $Id: seccomon.h,v 1.7 2007/10/12 01:44:51 julien.pierre.boogz%sun.com Exp $
 45 */
 46
 47#ifndef _SECCOMMON_H_
 48#define _SECCOMMON_H_
 49
 50#include "utilrename.h"
 51#include "prtypes.h"
 52
 53
 54#ifdef __cplusplus 
 55# define SEC_BEGIN_PROTOS extern "C" {
 56# define SEC_END_PROTOS }
 57#else
 58# define SEC_BEGIN_PROTOS
 59# define SEC_END_PROTOS
 60#endif
 61
 62#include "secport.h"
 63
 64typedef enum {
 65    siBuffer = 0,
 66    siClearDataBuffer = 1,
 67    siCipherDataBuffer = 2,
 68    siDERCertBuffer = 3,
 69    siEncodedCertBuffer = 4,
 70    siDERNameBuffer = 5,
 71    siEncodedNameBuffer = 6,
 72    siAsciiNameString = 7,
 73    siAsciiString = 8,
 74    siDEROID = 9,
 75    siUnsignedInteger = 10,
 76    siUTCTime = 11,
 77    siGeneralizedTime = 12,
 78    siVisibleString = 13,
 79    siUTF8String = 14,
 80    siBMPString = 15
 81} SECItemType;
 82
 83typedef struct SECItemStr SECItem;
 84
 85struct SECItemStr {
 86    SECItemType type;
 87    unsigned char *data;
 88    unsigned int len;
 89};
 90
 91/*
 92** A status code. Status's are used by procedures that return status
 93** values. Again the motivation is so that a compiler can generate
 94** warnings when return values are wrong. Correct testing of status codes:
 95**
 96**	SECStatus rv;
 97**	rv = some_function (some_argument);
 98**	if (rv != SECSuccess)
 99**		do_an_error_thing();
100**
101*/
102typedef enum _SECStatus {
103    SECWouldBlock = -2,
104    SECFailure = -1,
105    SECSuccess = 0
106} SECStatus;
107
108/*
109** A comparison code. Used for procedures that return comparision
110** values. Again the motivation is so that a compiler can generate
111** warnings when return values are wrong.
112*/
113typedef enum _SECComparison {
114    SECLessThan = -1,
115    SECEqual = 0,
116    SECGreaterThan = 1
117} SECComparison;
118
119#endif /* _SECCOMMON_H_ */