SecuritySNACCRuntime/c-lib/inc/asn-any.h

   1 /*
   2  * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18
  19 /*
  20  * asn_any.h
  21  *
  22  * MS 92
  23  * Copyright (C) 1992 Michael Sample and the University of British Columbia
  24  *
  25  * This library is free software; you can redistribute it and/or
  26  * modify it provided that this copyright/license information is retained
  27  * in original form.
  28  *
  29  * If you modify this file, you must clearly indicate your changes.
  30  *
  31  * This source code is distributed in the hope that it will be
  32  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  33  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  34  *
  35  * $Header: /cvs/Darwin/src/live/Security/SecuritySNACCRuntime/c-lib/inc/asn-any.h,v 1.1.1.1 2001/05/18 23:14:08 mb Exp $
  36  * $Log: asn-any.h,v $
  37  * Revision 1.1.1.1  2001/05/18 23:14:08  mb
  38  * Move from private repository to open source repository
  39  *
  40  * Revision 1.2  2001/05/05 00:59:22  rmurphy
  41  * Adding darwin license headers
  42  *
  43  * Revision 1.1.1.1  1999/03/16 18:06:19  aram
  44  * Originals from SMIME Free Library.
  45  *
  46  * Revision 1.3  1997/02/28 13:39:49  wan
  47  * Modifications collected for new version 1.3: Bug fixes, tk4.2.
  48  *
  49  * Revision 1.2  1995/07/24 21:01:07  rj
  50  * changed `_' to `-' in file names.
  51  *
  52  * Revision 1.1  1994/08/28  09:21:22  rj
  53  * first check-in. for a list of changes to the snacc-1.1 distribution please refer to the ChangeLog.
  54  *
  55  */
  56
  57 #ifndef _asn_any_h_
  58 #define _asn_any_h_
  59
  60 #include "hash.h"
  61
  62 /*
  63  * 1 hash table for integer keys
  64  * 1 hash table for oid keys
  65  */
  66 extern Table *anyOidHashTblG;
  67 extern Table *anyIntHashTblG;
  68
  69 typedef AsnLen (*EncodeFcn) PROTO ((BUF_TYPE b, void *value));
  70 typedef void (*DecodeFcn) PROTO ((BUF_TYPE b, void *value, AsnLen *bytesDecoded, ENV_TYPE env));
  71 typedef void (*FreeFcn)   PROTO ((void *v));
  72 typedef void (*PrintFcn)  PROTO ((FILE *f, void *v));
  73
  74 /*
  75  * this is put into the hash table with the
  76  * int or oid as the key
  77  */
  78 typedef struct AnyInfo
  79 {
  80   int           anyId;  /* will be a value from the AnyId enum */
  81   AsnOid        oid;    /* will be zero len/null if intId is valid */
  82   AsnInt        intId;
  83   unsigned int  size;  /* size of the C data type (ie as ret'd by sizeof) */
  84   EncodeFcn     Encode;
  85   DecodeFcn     Decode;
  86   FreeFcn       Free;
  87   PrintFcn      Print;
  88 } AnyInfo;
  89
  90
  91 typedef struct AsnAny
  92 {
  93   AnyInfo       *ai; /* point to entry in hash tbl that has routine ptrs */
  94   void          *value; /* points to the value */
  95 } AsnAny;
  96
  97 /*
  98  * Returns anyId value for the given ANY type.
  99  * Use this to determine to the type of an ANY after decoding
 100  * it. Returns -1 if the ANY info is not available
 101  */
 102 #define GetAsnAnyId( a)         (((a)->ai)? (a)->ai->anyId: -1)
 103
 104 /*
 105  * used before encoding or decoding a type so the proper
 106  * encode or decode routine is used.
 107  */
 108 void SetAnyTypeByInt PROTO ((AsnAny *v, AsnInt id));
 109 void SetAnyTypeByOid PROTO ((AsnAny *v, AsnOid *id));
 110
 111
 112 /*
 113  * used to initialize the hash table (s)
 114  */
 115 void InstallAnyByInt PROTO ((int anyId, AsnInt intId, unsigned int size, EncodeFcn encode, DecodeFcn decode, FreeFcn free, PrintFcn print));
 116
 117 void InstallAnyByOid PROTO ((int anyId, AsnOid *oid, unsigned int size, EncodeFcn encode, DecodeFcn decode, FreeFcn free, PrintFcn print));
 118
 119
 120 /*
 121  * Standard enc, dec, free, & print routines
 122  * for the AsnAny type.
 123  * These call the routines referenced from the
 124  * given value's hash table entry.
 125  */
 126 void FreeAsnAny PROTO ((AsnAny *v));
 127
 128 AsnLen BEncAsnAny PROTO ((BUF_TYPE b, AsnAny *v));
 129
 130 void BDecAsnAny PROTO ((BUF_TYPE b, AsnAny *result, AsnLen *bytesDecoded, ENV_TYPE env));
 131
 132 void PrintAsnAny PROTO ((FILE *f, AsnAny *v, unsigned short indent));
 133
 134
 135
 136 /* AnyDefinedBy is currently the same as AsnAny */
 137
 138 typedef AsnAny                  AsnAnyDefinedBy;
 139
 140 #define FreeAsnAnyDefinedBy     FreeAsnAny
 141
 142 #define BEncAsnAnyDefinedBy     BEncAsnAny
 143
 144 #define BDecAsnAnyDefinedBy     BDecAsnAny
 145
 146 #define PrintAsnAnyDefinedBy    PrintAsnAny
 147
 148
 149 #endif /* conditional include */