root/usr.bin/openssl/asn1pars.c
/* $OpenBSD: asn1pars.c,v 1.20 2026/01/31 09:01:09 tb Exp $ */
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 *
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 *
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 *
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

/* A nice addition from Dr Stephen Henson <steve@openssl.org> to
 * add the -strparse option which parses nested binary structures
 */

#include <stdio.h>
#include <stdlib.h>
#include <limits.h>
#include <string.h>

#include "apps.h"

#include <openssl/err.h>
#include <openssl/evp.h>
#include <openssl/pem.h>
#include <openssl/x509.h>

static struct {
        char *derfile;
        int dump;
        char *genconf;
        char *genstr;
        int indent;
        char *infile;
        int informat;
        unsigned int length;
        int noout;
        int offset;
        char *oidfile;
        STACK_OF(OPENSSL_STRING) *osk;
} cfg;

static int
asn1pars_opt_dlimit(char *arg)
{
        const char *errstr;

        cfg.dump = strtonum(arg, 1, INT_MAX, &errstr);
        if (errstr) {
                fprintf(stderr, "-dlimit must be from 1 to INT_MAX: %s\n",
                    errstr);
                return (-1);
        }
        return (0);
}

static int
asn1pars_opt_length(char *arg)
{
        const char *errstr;

        cfg.length = strtonum(arg, 1, UINT_MAX, &errstr);
        if (errstr) {
                fprintf(stderr, "-length must be from 1 to UINT_MAX: %s\n",
                    errstr);
                return (-1);
        }
        return (0);
}

static int
asn1pars_opt_strparse(char *arg)
{
        if (sk_OPENSSL_STRING_push(cfg.osk, arg) == 0) {
                fprintf(stderr, "-strparse cannot add argument\n");
                return (-1);
        }
        return (0);
}

static const struct option asn1pars_options[] = {
        {
                .name = "dump",
                .desc = "Dump unknown data in hex form",
                .type = OPTION_VALUE,
                .value = -1,
                .opt.value = &cfg.dump,
        },
        {
                .name = "dlimit",
                .argname = "num",
                .desc = "Dump the first num bytes of unknown data in hex form",
                .type = OPTION_ARG_FUNC,
                .opt.argfunc = asn1pars_opt_dlimit,
        },
        {
                .name = "genconf",
                .argname = "file",
                .desc = "File to generate ASN.1 structure from",
                .type = OPTION_ARG,
                .opt.arg = &cfg.genconf,
        },
        {
                .name = "genstr",
                .argname = "string",
                .desc = "String to generate ASN.1 structure from",
                .type = OPTION_ARG,
                .opt.arg = &cfg.genstr,
        },
        {
                .name = "i",
                .desc = "Indent output according to depth of structures",
                .type = OPTION_FLAG,
                .opt.flag = &cfg.indent,
        },
        {
                .name = "in",
                .argname = "file",
                .desc = "The input file (default stdin)",
                .type = OPTION_ARG,
                .opt.arg = &cfg.infile,
        },
        {
                .name = "inform",
                .argname = "fmt",
                .desc = "Input format (DER, TXT or PEM (default))",
                .type = OPTION_ARG_FORMAT,
                .opt.value = &cfg.informat,
        },
        {
                .name = "length",
                .argname = "num",
                .desc = "Number of bytes to parse (default until EOF)",
                .type = OPTION_ARG_FUNC,
                .opt.argfunc = asn1pars_opt_length,
        },
        {
                .name = "noout",
                .desc = "Do not produce any output",
                .type = OPTION_FLAG,
                .opt.flag = &cfg.noout,
        },
        {
                .name = "offset",
                .argname = "num",
                .desc = "Offset to begin parsing",
                .type = OPTION_ARG_INT,
                .opt.value = &cfg.offset,
        },
        {
                .name = "oid",
                .argname = "file",
                .desc = "File containing additional object identifiers (OIDs)",
                .type = OPTION_ARG,
                .opt.arg = &cfg.oidfile,
        },
        {
                .name = "out",
                .argname = "file",
                .desc = "Output file in DER format",
                .type = OPTION_ARG,
                .opt.arg = &cfg.derfile,
        },
        {
                .name = "strparse",
                .argname = "offset",
                .desc = "Parse the content octets of ASN.1 object starting at"
                " offset",
                .type = OPTION_ARG_FUNC,
                .opt.argfunc = asn1pars_opt_strparse,
        },
        { NULL },
};

static void
asn1pars_usage(void)
{
        fprintf(stderr,
            "usage: asn1parse [-i] [-dlimit num] [-dump] [-genconf file] "
            "[-genstr string]\n"
            "    [-in file] [-inform fmt] [-length num] [-noout] [-offset num] "
            "[-oid file]\n"
            "    [-out file] [-strparse offset]\n\n");
        options_usage(asn1pars_options);
}

static int do_generate(BIO *bio, char *genstr, char *genconf, BUF_MEM *buf);

int
asn1parse_main(int argc, char **argv)
{
        int i, j, ret = 1;
        long num;
        BIO *in = NULL, *out = NULL, *b64 = NULL, *derout = NULL;
        const char *errstr = NULL;
        const unsigned char *str;
        BUF_MEM *buf = NULL;
        ASN1_TYPE *at = NULL;

        if (pledge("stdio cpath wpath rpath", NULL) == -1) {
                perror("pledge");
                exit(1);
        }

        memset(&cfg, 0, sizeof(cfg));

        cfg.informat = FORMAT_PEM;
        if ((cfg.osk = sk_OPENSSL_STRING_new_null()) == NULL) {
                BIO_printf(bio_err, "Memory allocation failure\n");
                goto end;
        }

        if (options_parse(argc, argv, asn1pars_options, NULL, NULL) != 0) {
                asn1pars_usage();
                return (1);
        }

        in = BIO_new(BIO_s_file());
        out = BIO_new(BIO_s_file());
        if (in == NULL || out == NULL) {
                ERR_print_errors(bio_err);
                goto end;
        }
        BIO_set_fp(out, stdout, BIO_NOCLOSE | BIO_FP_TEXT);

        if (cfg.oidfile != NULL) {
                if (BIO_read_filename(in, cfg.oidfile) <= 0) {
                        BIO_printf(bio_err, "problems opening %s\n",
                            cfg.oidfile);
                        ERR_print_errors(bio_err);
                        goto end;
                }
                OBJ_create_objects(in);
        }
        if (cfg.infile == NULL)
                BIO_set_fp(in, stdin, BIO_NOCLOSE);
        else {
                if (BIO_read_filename(in, cfg.infile) <= 0) {
                        perror(cfg.infile);
                        goto end;
                }
        }

        if (cfg.derfile != NULL) {
                if ((derout = BIO_new_file(cfg.derfile, "wb")) == NULL) {
                        BIO_printf(bio_err, "problems opening %s\n",
                            cfg.derfile);
                        ERR_print_errors(bio_err);
                        goto end;
                }
        }
        if ((buf = BUF_MEM_new()) == NULL)
                goto end;
        if (!BUF_MEM_grow(buf, BUFSIZ * 8))
                goto end;

        if (cfg.genstr != NULL || cfg.genconf) {
                num = do_generate(bio_err, cfg.genstr, cfg.genconf, buf);
                if (num < 0) {
                        ERR_print_errors(bio_err);
                        goto end;
                }
        } else {
                if (cfg.informat == FORMAT_PEM) {
                        BIO *tmp;

                        if ((b64 = BIO_new(BIO_f_base64())) == NULL)
                                goto end;
                        BIO_push(b64, in);
                        tmp = in;
                        in = b64;
                        b64 = tmp;
                }
                num = 0;
                for (;;) {
                        if (!BUF_MEM_grow(buf, (int) num + BUFSIZ))
                                goto end;
                        i = BIO_read(in, &(buf->data[num]), BUFSIZ);
                        if (i <= 0)
                                break;
                        num += i;
                }
        }
        str = (const unsigned char *)buf->data;

        /* If any structs to parse go through in sequence */

        if (sk_OPENSSL_STRING_num(cfg.osk) > 0) {
                const unsigned char *p;
                const unsigned char *tmpbuf = str;
                long tmplen = num;

                for (i = 0; i < sk_OPENSSL_STRING_num(cfg.osk); i++) {
                        ASN1_TYPE *atmp;
                        int typ;
                        j = strtonum(sk_OPENSSL_STRING_value(cfg.osk, i),
                            1, INT_MAX, &errstr);
                        if (errstr) {
                                BIO_printf(bio_err,
                                    "'%s' is an invalid number: %s\n",
                                    sk_OPENSSL_STRING_value(cfg.osk, i), errstr);
                                continue;
                        }
                        tmpbuf += j;
                        tmplen -= j;
                        atmp = at;
                        p = tmpbuf;
                        at = d2i_ASN1_TYPE(NULL, &p, tmplen);
                        ASN1_TYPE_free(atmp);
                        if (!at) {
                                BIO_printf(bio_err, "Error parsing structure\n");
                                ERR_print_errors(bio_err);
                                goto end;
                        }
                        typ = ASN1_TYPE_get(at);
                        if (typ == V_ASN1_BOOLEAN || typ == V_ASN1_NULL ||
                            typ == V_ASN1_OBJECT) {
                                BIO_printf(bio_err, "Can't parse %s type\n",
                                    ASN1_tag2str(typ));
                                ERR_print_errors(bio_err);
                                goto end;
                        }
                        /* hmm... this is a little evil but it works */
                        tmpbuf = ASN1_STRING_get0_data(at->value.asn1_string);
                        tmplen = ASN1_STRING_length(at->value.asn1_string);
                }
                str = tmpbuf;
                num = tmplen;
        }
        if (cfg.offset >= num) {
                BIO_printf(bio_err, "Error: offset too large\n");
                goto end;
        }
        num -= cfg.offset;

        if (cfg.length == 0 || (long)cfg.length > num)
                cfg.length = (unsigned int) num;
        if (derout != NULL) {
                if (BIO_write(derout, str + cfg.offset,
                    cfg.length) != (int)cfg.length) {
                        BIO_printf(bio_err, "Error writing output\n");
                        ERR_print_errors(bio_err);
                        goto end;
                }
        }
        if (!cfg.noout && !ASN1_parse_dump(out, &str[cfg.offset], cfg.length,
            cfg.indent, cfg.dump)) {
                ERR_print_errors(bio_err);
                goto end;
        }
        ret = 0;
 end:
        BIO_free(derout);
        BIO_free(in);
        BIO_free_all(out);
        BIO_free(b64);
        if (ret != 0)
                ERR_print_errors(bio_err);
        BUF_MEM_free(buf);
        ASN1_TYPE_free(at);
        sk_OPENSSL_STRING_free(cfg.osk);
        OBJ_cleanup();

        return (ret);
}

static int
do_generate(BIO *bio, char *genstr, char *genconf, BUF_MEM *buf)
{
        CONF *cnf = NULL;
        int len;
        long errline;
        unsigned char *p;
        ASN1_TYPE *atyp = NULL;

        if (genconf) {
                cnf = NCONF_new(NULL);
                if (!NCONF_load(cnf, genconf, &errline))
                        goto conferr;
                if (!genstr)
                        genstr = NCONF_get_string(cnf, "default", "asn1");
                if (!genstr) {
                        BIO_printf(bio, "Can't find 'asn1' in '%s'\n", genconf);
                        goto err;
                }
        }
        atyp = ASN1_generate_nconf(genstr, cnf);
        NCONF_free(cnf);
        cnf = NULL;

        if (!atyp)
                return -1;

        len = i2d_ASN1_TYPE(atyp, NULL);
        if (len <= 0)
                goto err;

        if (!BUF_MEM_grow(buf, len))
                goto err;

        p = (unsigned char *) buf->data;

        i2d_ASN1_TYPE(atyp, &p);

        ASN1_TYPE_free(atyp);
        return len;

 conferr:

        if (errline > 0)
                BIO_printf(bio, "Error on line %ld of config file '%s'\n",
                    errline, genconf);
        else
                BIO_printf(bio, "Error loading config file '%s'\n", genconf);

 err:
        NCONF_free(cnf);
        ASN1_TYPE_free(atyp);

        return -1;

}