Back to index

lightning-sunbird  0.9+nobinonly
seccomon.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is the Netscape security libraries.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 1994-2000
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 /*
00038  * seccomon.h - common data structures for security libraries
00039  *
00040  * This file should have lowest-common-denominator datastructures
00041  * for security libraries.  It should not be dependent on any other
00042  * headers, and should not require linking with any libraries.
00043  *
00044  * $Id: seccomon.h,v 1.5 2004/04/25 15:03:18 gerv%gerv.net Exp $
00045  */
00046 
00047 #ifndef _SECCOMMON_H_
00048 #define _SECCOMMON_H_
00049 
00050 #include "prtypes.h"
00051 
00052 
00053 #ifdef __cplusplus 
00054 # define SEC_BEGIN_PROTOS extern "C" {
00055 # define SEC_END_PROTOS }
00056 #else
00057 # define SEC_BEGIN_PROTOS
00058 # define SEC_END_PROTOS
00059 #endif
00060 
00061 #include "secport.h"
00062 
00063 typedef enum {
00064     siBuffer = 0,
00065     siClearDataBuffer = 1,
00066     siCipherDataBuffer = 2,
00067     siDERCertBuffer = 3,
00068     siEncodedCertBuffer = 4,
00069     siDERNameBuffer = 5,
00070     siEncodedNameBuffer = 6,
00071     siAsciiNameString = 7,
00072     siAsciiString = 8,
00073     siDEROID = 9,
00074     siUnsignedInteger = 10,
00075     siUTCTime = 11,
00076     siGeneralizedTime = 12
00077 } SECItemType;
00078 
00079 typedef struct SECItemStr SECItem;
00080 
00081 struct SECItemStr {
00082     SECItemType type;
00083     unsigned char *data;
00084     unsigned int len;
00085 };
00086 
00087 /*
00088 ** A status code. Status's are used by procedures that return status
00089 ** values. Again the motivation is so that a compiler can generate
00090 ** warnings when return values are wrong. Correct testing of status codes:
00091 **
00092 **     SECStatus rv;
00093 **     rv = some_function (some_argument);
00094 **     if (rv != SECSuccess)
00095 **            do_an_error_thing();
00096 **
00097 */
00098 typedef enum _SECStatus {
00099     SECWouldBlock = -2,
00100     SECFailure = -1,
00101     SECSuccess = 0
00102 } SECStatus;
00103 
00104 /*
00105 ** A comparison code. Used for procedures that return comparision
00106 ** values. Again the motivation is so that a compiler can generate
00107 ** warnings when return values are wrong.
00108 */
00109 typedef enum _SECComparison {
00110     SECLessThan = -1,
00111     SECEqual = 0,
00112     SECGreaterThan = 1
00113 } SECComparison;
00114 
00115 #endif /* _SECCOMMON_H_ */