Add new interfaces to support PKCS7#7 signed data and authenticode signature. Update...
[mirror_edk2.git] / CryptoPkg / Include / OpenSslSupport.h
1 /** @file\r
2   Root include file to support building OpenSSL Crypto Library.\r
3 \r
4 Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution.  The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9 \r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12 \r
13 **/\r
14 \r
15 #ifndef __OPEN_SSL_SUPPORT_H__\r
16 #define __OPEN_SSL_SUPPORT_H__\r
17 \r
18 #include <Base.h>\r
19 #include <Library/BaseLib.h>\r
20 #include <Library/BaseMemoryLib.h>\r
21 #include <Library/MemoryAllocationLib.h>\r
22 #include <Library/DebugLib.h>\r
23 \r
24 //\r
25 // File operations are not required for building Open SSL, \r
26 // so FILE is mapped to VOID * to pass build\r
27 //\r
28 typedef VOID  *FILE;\r
29 \r
30 //\r
31 // Map all va_xxxx elements to VA_xxx defined in MdePkg/Include/Base.h\r
32 //\r
33 #if !defined(__CC_ARM) // if va_list is not already defined\r
34 #define va_list   VA_LIST\r
35 #define va_arg    VA_ARG\r
36 #define va_start  VA_START\r
37 #define va_end    VA_END\r
38 #else // __CC_ARM\r
39 #define va_start(Marker, Parameter)   __va_start(Marker, Parameter)\r
40 #define va_arg(Marker, TYPE)          __va_arg(Marker, TYPE)\r
41 #define va_end(Marker)                ((void)0)\r
42 #endif\r
43 \r
44 //\r
45 // #defines from EFI Application Toolkit required to buiild Open SSL\r
46 //\r
47 #define ENOMEM       12               /* Cannot allocate memory */\r
48 #define EINVAL       22               /* Invalid argument */\r
49 #define BUFSIZ       1024             /* size of buffer used by setbuf */\r
50 #define INT_MAX      2147483647       /* max value for an int */\r
51 #define INT_MIN      (-2147483647-1)  /* min value for an int */\r
52 #define LONG_MAX     2147483647L      /* max value for a long */\r
53 #define LONG_MIN     (-2147483647-1)  /* min value for a long */\r
54 #define ULONG_MAX    0xffffffff       /* max value for an unsigned long */\r
55 #define LOG_DAEMON   (3<<3)           /* system daemons */\r
56 #define LOG_EMERG    0                /* system is unusable */\r
57 #define LOG_ALERT    1                /* action must be taken immediately */\r
58 #define LOG_CRIT     2                /* critical conditions */\r
59 #define LOG_ERR      3                /* error conditions */\r
60 #define LOG_WARNING  4                /* warning conditions */\r
61 #define LOG_NOTICE   5                /* normal but significant condition */\r
62 #define LOG_INFO     6                /* informational */\r
63 #define LOG_DEBUG    7                /* debug-level messages */\r
64 #define LOG_PID      0x01             /* log the pid with each message */\r
65 #define LOG_CONS     0x02             /* log on the console if errors in sending */\r
66 \r
67 //\r
68 // Macros from EFI Application Toolkit required to buiild Open SSL\r
69 //\r
70 /* The offsetof() macro calculates the offset of a structure member\r
71    in its structure.  Unfortunately this cannot be written down\r
72    portably, hence it is provided by a Standard C header file.\r
73    For pre-Standard C compilers, here is a version that usually works\r
74    (but watch out!): */\r
75 #define offsetof(type, member) ( (int) & ((type*)0) -> member )\r
76 \r
77 //\r
78 // Basic types from EFI Application Toolkit required to buiild Open SSL\r
79 //\r
80 typedef UINTN          size_t;\r
81 typedef INTN           ssize_t;\r
82 typedef INT64          off_t;\r
83 typedef UINT16         mode_t;\r
84 typedef long           time_t;\r
85 typedef unsigned long  clock_t;\r
86 typedef UINT32         uid_t;\r
87 typedef UINT32         gid_t;\r
88 typedef UINT32         ino_t;\r
89 typedef UINT32         dev_t;\r
90 typedef UINT16         nlink_t;\r
91 typedef int            pid_t;\r
92 typedef void           *DIR;\r
93 typedef void           __sighandler_t (int);\r
94 \r
95 //\r
96 // Structures from EFI Application Toolkit required to buiild Open SSL\r
97 //\r
98 struct tm {\r
99   int   tm_sec;     /* seconds after the minute [0-60] */\r
100   int   tm_min;     /* minutes after the hour [0-59] */\r
101   int   tm_hour;    /* hours since midnight [0-23] */\r
102   int   tm_mday;    /* day of the month [1-31] */\r
103   int   tm_mon;     /* months since January [0-11] */\r
104   int   tm_year;    /* years since 1900 */\r
105   int   tm_wday;    /* days since Sunday [0-6] */\r
106   int   tm_yday;    /* days since January 1 [0-365] */\r
107   int   tm_isdst;   /* Daylight Savings Time flag */\r
108   long  tm_gmtoff;  /* offset from CUT in seconds */\r
109   char  *tm_zone;   /* timezone abbreviation */\r
110 };\r
111 \r
112 struct dirent {\r
113   UINT32  d_fileno;         /* file number of entry */\r
114   UINT16  d_reclen;         /* length of this record */\r
115   UINT8   d_type;           /* file type, see below */\r
116   UINT8   d_namlen;         /* length of string in d_name */\r
117   char    d_name[255 + 1];  /* name must be no longer than this */\r
118 };\r
119 \r
120 struct stat {\r
121   dev_t    st_dev;          /* inode's device */\r
122   ino_t    st_ino;          /* inode's number */\r
123   mode_t   st_mode;         /* inode protection mode */\r
124   nlink_t  st_nlink;        /* number of hard links */\r
125   uid_t    st_uid;          /* user ID of the file's owner */\r
126   gid_t    st_gid;          /* group ID of the file's group */\r
127   dev_t    st_rdev;         /* device type */\r
128   time_t   st_atime;        /* time of last access */\r
129   long     st_atimensec;    /* nsec of last access */\r
130   time_t   st_mtime;        /* time of last data modification */\r
131   long     st_mtimensec;    /* nsec of last data modification */\r
132   time_t   st_ctime;        /* time of last file status change */\r
133   long     st_ctimensec;    /* nsec of last file status change */\r
134   off_t    st_size;         /* file size, in bytes */\r
135   INT64    st_blocks;       /* blocks allocated for file */\r
136   UINT32   st_blksize;      /* optimal blocksize for I/O */\r
137   UINT32   st_flags;        /* user defined flags for file */\r
138   UINT32   st_gen;          /* file generation number */\r
139   INT32    st_lspare;\r
140   INT64    st_qspare[2];\r
141 };\r
142 \r
143 //\r
144 // Externs from EFI Application Toolkit required to buiild Open SSL\r
145 //\r
146 extern int errno;\r
147 \r
148 //\r
149 // Function prototypes from EFI Application Toolkit required to buiild Open SSL\r
150 //\r
151 void           *malloc     (size_t);\r
152 void           *realloc    (void *, size_t);\r
153 void           free        (void *);\r
154 int            isdigit     (int);\r
155 int            isspace     (int);\r
156 int            tolower     (int);\r
157 int            isupper     (int);\r
158 int            isxdigit    (int);\r
159 int            isalnum     (int);\r
160 void           *memcpy     (void *, const void *, size_t);\r
161 void           *memset     (void *, int, size_t);\r
162 void           *memchr     (const void *, int, size_t);\r
163 int            memcmp      (const void *, const void *, size_t);\r
164 void           *memmove    (void *, const void *, size_t);\r
165 int            strcmp      (const char *, const char *);\r
166 int            strncmp     (const char *, const char *, size_t);\r
167 char           *strcpy     (char *, const char *);\r
168 char           *strncpy    (char *, const char *, size_t);\r
169 size_t         strlen      (const char *);\r
170 char           *strcat     (char *, const char *);\r
171 char           *strchr     (const char *, int);\r
172 int            strcasecmp  (const char *, const char *);\r
173 int            strncasecmp (const char *, const char *, size_t);\r
174 char           *strncpy    (char *, const char *, size_t);\r
175 int            strncmp     (const char *, const char *, size_t);\r
176 char           *strrchr    (const char *, int);\r
177 unsigned long  strtoul     (const char *, char **, int);\r
178 long           strtol      (const char *, char **, int);\r
179 int            printf      (const char *, ...);\r
180 int            sscanf      (const char *, const char *, ...);\r
181 int            open        (const char *, int, ...);\r
182 int            chmod       (const char *, mode_t);\r
183 int            stat        (const char *, struct stat *);\r
184 off_t          lseek       (int, off_t, int);\r
185 ssize_t        read        (int, void *, size_t);\r
186 ssize_t        write       (int, const void *, size_t);\r
187 int            close       (int);\r
188 FILE           *fopen      (const char *, const char *);\r
189 size_t         fread       (void *, size_t, size_t, FILE *);\r
190 size_t         fwrite      (const void *, size_t, size_t, FILE *);\r
191 char           *fgets      (char *, int, FILE *);\r
192 int            fputs       (const char *, FILE *);\r
193 int            fprintf     (FILE *, const char *, ...);\r
194 int            vfprintf    (FILE *, const char *, VA_LIST);\r
195 int            fflush      (FILE *);\r
196 int            fclose      (FILE *);\r
197 DIR            *opendir    (const char *);\r
198 struct dirent  *readdir    (DIR *);\r
199 int            closedir    (DIR *);\r
200 void           openlog     (const char *, int, int);\r
201 void           closelog    (void);\r
202 void           syslog      (int, const char *, ...);\r
203 time_t         time        (time_t *);\r
204 struct tm      *localtime  (const time_t *);\r
205 struct tm      *gmtime     (const time_t *);\r
206 struct tm      *gmtime_r   (const time_t *, struct tm *);\r
207 uid_t          getuid      (void);\r
208 uid_t          geteuid     (void);\r
209 gid_t          getgid      (void);\r
210 gid_t          getegid     (void);\r
211 void           qsort       (void *, size_t, size_t, int (*)(const void *, const void *));\r
212 char           *getenv     (const char *);\r
213 void           exit        (int);\r
214 void           abort       (void);\r
215 __sighandler_t *signal     (int, __sighandler_t *);\r
216 \r
217 //\r
218 // Global variables from EFI Application Toolkit required to buiild Open SSL\r
219 //\r
220 extern FILE  *stderr;\r
221 extern FILE  *stdin;\r
222 extern FILE  *stdout;\r
223 \r
224 //\r
225 // Macros that directly map functions to BaseLib, BaseMemoryLib, and DebugLib functions\r
226 //\r
227 #define memcpy(dest,source,count)         CopyMem(dest,source,(UINTN)(count))\r
228 #define memset(dest,ch,count)             SetMem(dest,(UINTN)(count),(UINT8)(ch))\r
229 #define memchr(buf,ch,count)              ScanMem8(buf,(UINTN)(count),(UINT8)ch)\r
230 #define memcmp(buf1,buf2,count)           (int)(CompareMem(buf1,buf2,(UINTN)(count)))\r
231 #define memmove(dest,source,count)        CopyMem(dest,source,(UINTN)(count))\r
232 #define strcmp                            AsciiStrCmp\r
233 #define strncmp(string1,string2,count)    (int)(AsciiStrnCmp(string1,string2,(UINTN)(count)))\r
234 #define strcpy(strDest,strSource)         AsciiStrCpy(strDest,strSource)\r
235 #define strncpy(strDest,strSource,count)  AsciiStrnCpy(strDest,strSource,(UINTN)count)\r
236 #define strlen(str)                       (size_t)(AsciiStrLen(str))\r
237 #define strcat(strDest,strSource)         AsciiStrCat(strDest,strSource)\r
238 #define strchr(str,ch)                    ScanMem8((VOID *)(str),AsciiStrSize(str),(UINT8)ch)\r
239 #define abort()                           ASSERT (FALSE)\r
240 #define assert(expression)\r
241 #define localtime(timer)                  NULL\r
242 #define gmtime_r(timer,result)            (result = NULL)\r
243 \r
244 #endif\r