security/nss/lib/util/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.6 2007/09/07 18:45:53 neil.williams%sun.com Exp $
  45  */
  46
  47 #ifndef _SECCOMMON_H_
  48 #define _SECCOMMON_H_
  49
  50 #include "prtypes.h"
  51
  52
  53 #ifdef __cplusplus
  54 # define SEC_BEGIN_PROTOS extern "C" {
  55 # define SEC_END_PROTOS }
  56 #else
  57 # define SEC_BEGIN_PROTOS
  58 # define SEC_END_PROTOS
  59 #endif
  60
  61 #include "secport.h"
  62
  63 typedef enum {
  64     siBuffer = 0,
  65     siClearDataBuffer = 1,
  66     siCipherDataBuffer = 2,
  67     siDERCertBuffer = 3,
  68     siEncodedCertBuffer = 4,
  69     siDERNameBuffer = 5,
  70     siEncodedNameBuffer = 6,
  71     siAsciiNameString = 7,
  72     siAsciiString = 8,
  73     siDEROID = 9,
  74     siUnsignedInteger = 10,
  75     siUTCTime = 11,
  76     siGeneralizedTime = 12,
  77     siVisibleString = 13,
  78     siUTF8String = 14,
  79     siBMPString = 15
  80 } SECItemType;
  81
  82 typedef struct SECItemStr SECItem;
  83
  84 struct SECItemStr {
  85     SECItemType type;
  86     unsigned char *data;
  87     unsigned int len;
  88 };
  89
  90 /*
  91 ** A status code. Status's are used by procedures that return status
  92 ** values. Again the motivation is so that a compiler can generate
  93 ** warnings when return values are wrong. Correct testing of status codes:
  94 **
  95 **      SECStatus rv;
  96 **      rv = some_function (some_argument);
  97 **      if (rv != SECSuccess)
  98 **              do_an_error_thing();
  99 **
 100 */
 101 typedef enum _SECStatus {
 102     SECWouldBlock = -2,
 103     SECFailure = -1,
 104     SECSuccess = 0
 105 } SECStatus;
 106
 107 /*
 108 ** A comparison code. Used for procedures that return comparision
 109 ** values. Again the motivation is so that a compiler can generate
 110 ** warnings when return values are wrong.
 111 */
 112 typedef enum _SECComparison {
 113     SECLessThan = -1,
 114     SECEqual = 0,
 115     SECGreaterThan = 1
 116 } SECComparison;
 117
 118 #endif /* _SECCOMMON_H_ */