xref: /openssl/apps/include/fmt.h (revision aff636a4)
1 /*
2  * Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9 
10 /*
11  * Options are shared by apps (see apps.h) and the test system
12  * (see test/testutil.h').
13  * In order to remove the dependency between apps and options, the following
14  * shared fields have been moved into this file.
15  */
16 
17 #ifndef OSSL_APPS_FMT_H
18 #define OSSL_APPS_FMT_H
19 
20 /*
21  * On some platforms, it's important to distinguish between text and binary
22  * files.  On some, there might even be specific file formats for different
23  * contents.  The FORMAT_xxx macros are meant to express an intent with the
24  * file being read or created.
25  */
26 # define B_FORMAT_TEXT   0x8000
27 # define FORMAT_UNDEF    0
28 # define FORMAT_TEXT    (1 | B_FORMAT_TEXT)     /* Generic text */
29 # define FORMAT_BINARY   2                      /* Generic binary */
30 # define FORMAT_BASE64  (3 | B_FORMAT_TEXT)     /* Base64 */
31 # define FORMAT_ASN1     4                      /* ASN.1/DER */
32 # define FORMAT_PEM     (5 | B_FORMAT_TEXT)
33 # define FORMAT_PKCS12   6
34 # define FORMAT_SMIME   (7 | B_FORMAT_TEXT)
35 # define FORMAT_ENGINE   8                      /* Not really a file format */
36 # define FORMAT_PEMRSA  (9 | B_FORMAT_TEXT)     /* PEM RSAPublicKey format */
37 # define FORMAT_ASN1RSA  10                     /* DER RSAPublicKey format */
38 # define FORMAT_MSBLOB   11                     /* MS Key blob format */
39 # define FORMAT_PVK      12                     /* MS PVK file format */
40 # define FORMAT_HTTP     13                     /* Download using HTTP */
41 # define FORMAT_NSS      14                     /* NSS keylog format */
42 
43 int FMT_istext(int format);
44 
45 #endif /* OSSL_APPS_FMT_H_ */
46