Skip to content

/ openssl

Permalink
Browse files
Change the way apps open their input and output files 
The different apps had the liberty to decide whether they would open their
input and output files in binary mode or not, which could be confusing if
two different apps were handling the same type of file in different ways.

The solution is to centralise the decision of low level file organisation,
and that the apps would use a selection of formats to state the intent of
the file.

Reviewed-by: Tim Hudson <tjh@openssl.org>
  • Loading branch information
@levitte
levitte committed Sep 5, 2015
1 parent d303b9d commit bdd58d98467e9f0f6635c1628e1eae304383afb1
Unified Split
Showing with 168 additions and 144 deletions.
  1. +7 −14 apps/apps.c
  2. +16 −14 apps/apps.h
  3. +3 −3 apps/asn1pars.c
  4. +2 −1 apps/ca.c
  5. +6 −11 apps/cms.c
  6. +1 −1 apps/crl.c
  7. +2 −2 apps/crl2p7.c
  8. +1 −1 apps/dgst.c
  9. +2 −2 apps/dhparam.c
  10. +1 −1 apps/dsa.c
  11. +2 −2 apps/dsaparam.c
  12. +2 −2 apps/ec.c
  13. +2 −2 apps/ecparam.c
  14. +8 −8 apps/enc.c
  15. +2 −2 apps/gendsa.c
  16. +1 −1 apps/genpkey.c
  17. +1 −1 apps/genrsa.c
  18. +2 −2 apps/nseq.c
  19. +5 −5 apps/ocsp.c
  20. +43 −14 apps/openssl.c
  21. +1 −1 apps/passwd.c
  22. +12 −7 apps/pkcs12.c
  23. +2 −2 apps/pkcs7.c
  24. +2 −2 apps/pkcs8.c
  25. +1 −1 apps/pkey.c
  26. +2 −2 apps/pkeyparam.c
  27. +2 −2 apps/pkeyutl.c
  28. +8 −8 apps/rand.c
  29. +4 −4 apps/req.c
  30. +1 −1 apps/rsa.c
  31. +2 −2 apps/rsautl.c
  32. +2 −2 apps/sess_id.c
  33. +6 −11 apps/smime.c
  34. +2 −2 apps/spkac.c
  35. +10 −6 apps/ts.c
  36. +2 −2 apps/x509.c
21 apps/apps.c
View file
@@ -514,7 +514,7 @@ CONF *app_load_config(const char *filename)
BIO *in;
CONF *conf;

in = bio_open_default(filename, "r");
in = bio_open_default(filename, 'r', FORMAT_TEXT);
if (in == NULL)
return NULL;

@@ -527,7 +527,7 @@ CONF *app_load_config_quiet(const char *filename)
BIO *in;
CONF *conf;

in = bio_open_default_quiet(filename, "r");
in = bio_open_default_quiet(filename, 'r', FORMAT_TEXT);
if (in == NULL)
return NULL;

@@ -683,7 +683,7 @@ X509 *load_cert(const char *file, int format,
unbuffer(stdin);
cert = dup_bio_in();
} else
cert = bio_open_default(file, RB(format));
cert = bio_open_default(file, 'r', format);
if (cert == NULL)
goto end;

@@ -718,7 +718,7 @@ X509_CRL *load_crl(const char *infile, int format)
return x;
}

in = bio_open_default(infile, RB(format));
in = bio_open_default(infile, 'r', format);
if (in == NULL)
goto end;
if (format == FORMAT_ASN1)
@@ -772,7 +772,7 @@ EVP_PKEY *load_key(const char *file, int format, int maybe_stdin,
unbuffer(stdin);
key = dup_bio_in();
} else
key = bio_open_default(file, RB(format));
key = bio_open_default(file, 'r', format);
if (key == NULL)
goto end;
if (format == FORMAT_ASN1) {
@@ -808,13 +808,6 @@ EVP_PKEY *load_key(const char *file, int format, int maybe_stdin,
return (pkey);
}

static const char *key_file_format(int format)
{
if (format == FORMAT_PEM || format == FORMAT_PEMRSA)
return "r";
return "rb";
}

EVP_PKEY *load_pubkey(const char *file, int format, int maybe_stdin,
const char *pass, ENGINE *e, const char *key_descrip)
{
@@ -842,7 +835,7 @@ EVP_PKEY *load_pubkey(const char *file, int format, int maybe_stdin,
unbuffer(stdin);
key = dup_bio_in();
} else
key = bio_open_default(file, key_file_format(format));
key = bio_open_default(file, 'r', format);
if (key == NULL)
goto end;
if (format == FORMAT_ASN1) {
@@ -909,7 +902,7 @@ static int load_certs_crls(const char *file, int format,
return 0;
}

bio = bio_open_default(file, "r");
bio = bio_open_default(file, 'r', FORMAT_PEM);
if (bio == NULL)
return 0;

30 apps/apps.h
View file
@@ -154,19 +154,14 @@ extern BIO *bio_out;
extern BIO *bio_err;
BIO *dup_bio_in(void);
BIO *dup_bio_out(void);
BIO *bio_open_owner(const char *filename, const char *mode, int private);
BIO *bio_open_default(const char *filename, const char *mode);
BIO *bio_open_default_quiet(const char *filename, const char *mode);
BIO *bio_open_owner(const char *filename, int format, int private);
BIO *bio_open_default(const char *filename, char mode, int format);
BIO *bio_open_default_quiet(const char *filename, char mode, int format);
CONF *app_load_config(const char *filename);
CONF *app_load_config_quiet(const char *filename);
int app_load_modules(const CONF *config);
void unbuffer(FILE *fp);

/* Often used in calls to bio_open_default. */
# define RB(xformat) (((xformat) & B_FORMAT_TEXT) ? "rb" : "r")
# define WB(xformat) (((xformat) & B_FORMAT_TEXT) ? "wb" : "w")
# define AB(xformat) (((xformat) & B_FORMAT_TEXT) ? "ab" : "a")

/*
* Common verification options.
*/
@@ -536,14 +531,21 @@ void print_cert_checks(BIO *bio, X509 *x,
void store_setup_crl_download(X509_STORE *st);

/* See OPT_FMT_xxx, above. */
/* On some platforms, it's important to distinguish between text and binary
* files. On some, there might even be specific file formats for different
* contents. The FORMAT_xxx macros are meant to express an intent with the
* file being read or created.
*/
# define B_FORMAT_TEXT 0x8000
# define FORMAT_UNDEF 0
# define FORMAT_ASN1 1
# define FORMAT_TEXT (2 | B_FORMAT_TEXT)
# define FORMAT_PEM (3 | B_FORMAT_TEXT)
# define FORMAT_PKCS12 5
# define FORMAT_SMIME (6 | B_FORMAT_TEXT)
# define FORMAT_ENGINE 7
# define FORMAT_TEXT (1 | B_FORMAT_TEXT) /* Generic text */
# define FORMAT_BINARY 2 /* Generic binary */
# define FORMAT_BASE64 (3 | B_FORMAT_TEXT) /* Base64 */
# define FORMAT_ASN1 4 /* ASN.1/DER */
# define FORMAT_PEM (5 | B_FORMAT_TEXT)
# define FORMAT_PKCS12 6
# define FORMAT_SMIME (7 | B_FORMAT_TEXT)
# define FORMAT_ENGINE 8 /* Not really a file format */
# define FORMAT_PEMRSA (9 | B_FORMAT_TEXT) /* PEM RSAPubicKey format */
# define FORMAT_ASN1RSA 10 /* DER RSAPubicKey format */
# define FORMAT_MSBLOB 11 /* MS Key blob format */
6 apps/asn1pars.c
View file
@@ -190,17 +190,17 @@ int asn1parse_main(int argc, char **argv)
goto end;

if (oidfile != NULL) {
in = bio_open_default(oidfile, "r");
in = bio_open_default(oidfile, 'r', FORMAT_TEXT);
if (in == NULL)
goto end;
OBJ_create_objects(in);
BIO_free(in);
}

if ((in = bio_open_default(infile, RB(informat))) == NULL)
if ((in = bio_open_default(infile, 'r', informat)) == NULL)
goto end;

if (derfile && (derout = bio_open_default(derfile, "wb")) == NULL)
if (derfile && (derout = bio_open_default(derfile, 'w', FORMAT_ASN1)) == NULL)
goto end;

if (strictpem) {
3 apps/ca.c
View file
@@ -795,7 +795,8 @@ int ca_main(int argc, char **argv)

/*****************************************************************/
if (req || gencrl) {
Sout = bio_open_default(outfile, "w");
/* FIXME: Is it really always text? */
Sout = bio_open_default(outfile, 'w', FORMAT_TEXT);
if (Sout == NULL)
goto end;
}
17 apps/cms.c
View file
@@ -247,7 +247,6 @@ int cms_main(int argc, char **argv)
NULL;
char *to = NULL, *from = NULL, *subject = NULL, *prog;
cms_key_param *key_first = NULL, *key_param = NULL;
const char *inmode = "r", *outmode = "w";
int flags = CMS_DETACHED, noout = 0, print = 0, keyidx = -1, vpmtouched =
0;
int informat = FORMAT_SMIME, outformat = FORMAT_SMIME;
@@ -689,18 +688,14 @@ int cms_main(int argc, char **argv)
if (!(operation & SMIME_SIGNERS))
flags &= ~CMS_DETACHED;

if (operation & SMIME_OP) {
outmode = WB(outformat);
} else {
if (!(operation & SMIME_OP)) {
if (flags & CMS_BINARY)
outmode = "wb";
outformat = FORMAT_BINARY;
}

if (operation & SMIME_IP) {
inmode = RB(informat);
} else {
if (!(operation & SMIME_IP)) {
if (flags & CMS_BINARY)
inmode = "rb";
informat = FORMAT_BINARY;
}

if (operation == SMIME_ENCRYPT) {
@@ -770,7 +765,7 @@ int cms_main(int argc, char **argv)
goto end;
}

in = bio_open_default(infile, inmode);
in = bio_open_default(infile, 'r', informat);
if (in == NULL)
goto end;

@@ -834,7 +829,7 @@ int cms_main(int argc, char **argv)
}
}

out = bio_open_default(outfile, outmode);
out = bio_open_default(outfile, 'w', outformat);
if (out == NULL)
goto end;

2 apps/crl.c
View file
@@ -346,7 +346,7 @@ int crl_main(int argc, char **argv)
}
}
}
out = bio_open_default(outfile, WB(outformat));
out = bio_open_default(outfile, 'w', outformat);
if (out == NULL)
goto end;

4 apps/crl2p7.c
View file
@@ -152,7 +152,7 @@ int crl2pkcs7_main(int argc, char **argv)
goto end;

if (!nocrl) {
in = bio_open_default(infile, RB(informat));
in = bio_open_default(infile, 'r', informat);
if (in == NULL)
goto end;

@@ -201,7 +201,7 @@ int crl2pkcs7_main(int argc, char **argv)

sk_OPENSSL_STRING_free(certflst);

out = bio_open_default(outfile, WB(outformat));
out = bio_open_default(outfile, 'w', outformat);
if (out == NULL)
goto end;

2 apps/dgst.c
View file
@@ -275,7 +275,7 @@ int dgst_main(int argc, char **argv)
if (randfile)
app_RAND_load_file(randfile, 0);

out = bio_open_default(outfile, out_bin ? "wb" : "w");
out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
if (out == NULL)
goto end;

4 apps/dhparam.c
View file
@@ -309,7 +309,7 @@ int dhparam_main(int argc, char **argv)
app_RAND_write_file(NULL);
} else {

in = bio_open_default(infile, RB(informat));
in = bio_open_default(infile, 'r', informat);
if (in == NULL)
goto end;

@@ -352,7 +352,7 @@ int dhparam_main(int argc, char **argv)
/* dh != NULL */
}

out = bio_open_default(outfile, WB(outformat));
out = bio_open_default(outfile, 'w', outformat);
if (out == NULL)
goto end;

2 apps/dsa.c
View file
@@ -225,7 +225,7 @@ int dsa_main(int argc, char **argv)
goto end;
}

out = bio_open_owner(outfile, WB(outformat), private);
out = bio_open_owner(outfile, outformat, private);
if (out == NULL)
goto end;

4 apps/dsaparam.c
View file
@@ -195,10 +195,10 @@ int dsaparam_main(int argc, char **argv)
}
private = genkey ? 1 : 0;

in = bio_open_default(infile, RB(informat));
in = bio_open_default(infile, 'r', informat);
if (in == NULL)
goto end;
out = bio_open_owner(outfile, WB(outformat), private);
out = bio_open_owner(outfile, outformat, private);
if (out == NULL)
goto end;

4 apps/ec.c
View file
@@ -205,7 +205,7 @@ int ec_main(int argc, char **argv)
if (!app_load_modules(NULL))
goto end;

in = bio_open_default(infile, RB(informat));
in = bio_open_default(infile, 'r', informat);
if (in == NULL)
goto end;

@@ -227,7 +227,7 @@ int ec_main(int argc, char **argv)
goto end;
}

out = bio_open_owner(outfile, WB(outformat), private);
out = bio_open_owner(outfile, outformat, private);
if (out == NULL)
goto end;

4 apps/ecparam.c
View file
@@ -223,10 +223,10 @@ int ecparam_main(int argc, char **argv)
if (!app_load_modules(NULL))
goto end;

in = bio_open_default(infile, RB(informat));
in = bio_open_default(infile, 'r', informat);
if (in == NULL)
goto end;
out = bio_open_owner(outfile, WB(outformat), private);
out = bio_open_owner(outfile, outformat, private);
if (out == NULL)
goto end;

16 apps/enc.c
View file
@@ -138,7 +138,7 @@ int enc_main(int argc, char **argv)
char mbuf[sizeof magic - 1];
OPTION_CHOICE o;
int bsize = BSIZE, verbose = 0, debug = 0, olb64 = 0, nosalt = 0;
int enc = 1, printkey = 0, i, k, base64 = 0;
int enc = 1, printkey = 0, i, k, format = FORMAT_BINARY;
int ret = 1, inl, nopad = 0, non_fips_allow = 0;
unsigned char key[EVP_MAX_KEY_LENGTH], iv[EVP_MAX_IV_LENGTH];
unsigned char *buff = NULL, salt[PKCS5_SALT_LEN];
@@ -151,7 +151,7 @@ int enc_main(int argc, char **argv)
/* first check the program name */
prog = opt_progname(argv[0]);
if (strcmp(prog, "base64") == 0)
base64 = 1;
format = FORMAT_BASE64;
#ifdef ZLIB
else if (strcmp(prog, "zlib") == 0)
do_zlib = 1;
@@ -223,7 +223,7 @@ int enc_main(int argc, char **argv)
olb64 = 1;
break;
case OPT_A:
base64 = 1;
format = FORMAT_BASE64;
break;
case OPT_Z:
#ifdef ZLIB
@@ -246,7 +246,7 @@ int enc_main(int argc, char **argv)
str = opt_arg();
break;
case OPT_KFILE:
in = bio_open_default(opt_arg(), "r");
in = bio_open_default(opt_arg(), 'r', FORMAT_TEXT);
if (in == NULL)
goto opthelp;
i = BIO_gets(in, buf, sizeof buf);
@@ -311,7 +311,7 @@ int enc_main(int argc, char **argv)
dgst = EVP_md5();

/* It must be large enough for a base64 encoded line */
if (base64 && bsize < 80)
if (format == FORMAT_BASE64 && bsize < 80)
bsize = 80;
if (verbose)
BIO_printf(bio_err, "bufsize=%d\n", bsize);
@@ -330,7 +330,7 @@ int enc_main(int argc, char **argv)
unbuffer(stdin);
in = dup_bio_in();
} else
in = bio_open_default(infile, base64 ? "r" : "rb");
in = bio_open_default(infile, 'r', format);
if (in == NULL)
goto end;

@@ -366,7 +366,7 @@ int enc_main(int argc, char **argv)
}
}

out = bio_open_default(outfile, base64 ? "w" : "wb");
out = bio_open_default(outfile, 'w', format);
if (out == NULL)
goto end;

@@ -384,7 +384,7 @@ int enc_main(int argc, char **argv)
}
#endif

if (base64) {
if (format == FORMAT_BASE64) {
if ((b64 = BIO_new(BIO_f_base64())) == NULL)
goto end;
if (debug) {

0 comments on commit bdd58d9

Please sign in to comment.