/src/openssl/crypto/x509/x509_vpm.c

Source
/*
 * Copyright 2004-2025 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <stdio.h>

#include "internal/cryptlib.h"
#include <openssl/crypto.h>
#include <openssl/buffer.h>
#include <openssl/x509.h>
#include <openssl/x509v3.h>
#include "crypto/x509.h"

#include "x509_local.h"

/* X509_VERIFY_PARAM functions */

#define SET_HOST 0
#define ADD_HOST 1

static char *str_copy(const char *s)
{
    return OPENSSL_strdup(s);
}

static void str_free(char *s)
{
    OPENSSL_free(s);
}

static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
    const char *name, size_t namelen)
{
    char *copy;

    /*
     * Refuse names with embedded NUL bytes, except perhaps as final byte.
     * XXX: Do we need to push an error onto the error stack?
     */
    if (namelen == 0 || name == NULL)
        namelen = name ? strlen(name) : 0;
    else if (name != NULL
        && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen) != NULL)
        return 0;
    if (namelen > 0 && name[namelen - 1] == '\0')
        --namelen;

    if (mode == SET_HOST) {
        sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
        vpm->hosts = NULL;
    }
    if (name == NULL || namelen == 0)
        return 1;

    copy = OPENSSL_strndup(name, namelen);
    if (copy == NULL)
        return 0;

    if (vpm->hosts == NULL && (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
        OPENSSL_free(copy);
        return 0;
    }

    if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
        OPENSSL_free(copy);
        if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
            sk_OPENSSL_STRING_free(vpm->hosts);
            vpm->hosts = NULL;
        }
        return 0;
    }

    return 1;
}

X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
{
    X509_VERIFY_PARAM *param;

    param = OPENSSL_zalloc(sizeof(*param));
    if (param == NULL)
        return NULL;
    param->trust = X509_TRUST_DEFAULT;
    /* param->inh_flags = X509_VP_FLAG_DEFAULT; */
    param->depth = -1;
    param->auth_level = -1; /* -1 means unset, 0 is explicit */
    return param;
}

void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
{
    if (param == NULL)
        return;
    sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
    sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
    OPENSSL_free(param->peername);
    OPENSSL_free(param->email);
    OPENSSL_free(param->ip);
    OPENSSL_free(param);
}

/*-
 * This function determines how parameters are "inherited" from one structure
 * to another. There are several different ways this can happen.
 *
 * 1. If a child structure needs to have its values initialized from a parent
 *    they are simply copied across. For example SSL_CTX copied to SSL.
 * 2. If the structure should take on values only if they are currently unset.
 *    For example the values in an SSL structure will take appropriate value
 *    for SSL servers or clients but only if the application has not set new
 *    ones.
 *
 * The "inh_flags" field determines how this function behaves.
 *
 * Normally any values which are set in the default are not copied from the
 * destination and verify flags are ORed together.
 *
 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
 * to the destination. Effectively the values in "to" become default values
 * which will be used only if nothing new is set in "from".
 *
 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
 * they are set or not. Flags is still Ored though.
 *
 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
 * of ORed.
 *
 * If X509_VP_FLAG_LOCKED is set then no values are copied.
 *
 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
 * after the next call.
 */

/* Macro to test if a field should be copied from src to dest */

#define test_x509_verify_param_copy(field, def) \
    (to_overwrite || (src->field != def && (to_default || dest->field == def)))

/* Macro to test and copy a field if necessary */

#define x509_verify_param_copy(field, def)       \
    if (test_x509_verify_param_copy(field, def)) \
        dest->field = src->field;

int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
    const X509_VERIFY_PARAM *src)
{
    unsigned long inh_flags;
    int to_default, to_overwrite;

    if (src == NULL)
        return 1;
    inh_flags = dest->inh_flags | src->inh_flags;

    if ((inh_flags & X509_VP_FLAG_ONCE) != 0)
        dest->inh_flags = 0;

    if ((inh_flags & X509_VP_FLAG_LOCKED) != 0)
        return 1;

    to_default = (inh_flags & X509_VP_FLAG_DEFAULT) != 0;
    to_overwrite = (inh_flags & X509_VP_FLAG_OVERWRITE) != 0;

    x509_verify_param_copy(purpose, 0);
    x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
    x509_verify_param_copy(depth, -1);
    x509_verify_param_copy(auth_level, -1);

    /* If overwrite or check time not set, copy across */

    if (to_overwrite || (dest->flags & X509_V_FLAG_USE_CHECK_TIME) == 0) {
        dest->check_time = src->check_time;
        dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
        /* Don't need to copy flag: that is done below */
    }

    if ((inh_flags & X509_VP_FLAG_RESET_FLAGS) != 0)
        dest->flags = 0;

    dest->flags |= src->flags;

    if (test_x509_verify_param_copy(policies, NULL)) {
        if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
            return 0;
    }

    x509_verify_param_copy(hostflags, 0);

    if (test_x509_verify_param_copy(hosts, NULL)) {
        sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
        dest->hosts = NULL;
        if (src->hosts != NULL) {
            dest->hosts = sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
            if (dest->hosts == NULL)
                return 0;
        }
    }

    if (test_x509_verify_param_copy(email, NULL)) {
        if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
            return 0;
    }

    if (test_x509_verify_param_copy(ip, NULL)) {
        if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
            return 0;
    }

    return 1;
}

int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
    const X509_VERIFY_PARAM *from)
{
    unsigned long save_flags;
    int ret;

    if (to == NULL) {
        ERR_raise(ERR_LIB_X509, ERR_R_PASSED_NULL_PARAMETER);
        return 0;
    }
    save_flags = to->inh_flags;
    to->inh_flags |= X509_VP_FLAG_DEFAULT;
    ret = X509_VERIFY_PARAM_inherit(to, from);
    to->inh_flags = save_flags;
    return ret;
}

static int int_x509_param_set1(char **pdest, size_t *pdestlen,
    const char *src, size_t srclen)
{
    char *tmp;

    if (src != NULL) {
        if (srclen == 0)
            srclen = strlen(src);

        tmp = OPENSSL_malloc(srclen + 1);
        if (tmp == NULL)
            return 0;
        memcpy(tmp, src, srclen);
        tmp[srclen] = '\0'; /* enforce NUL termination */
    } else {
        tmp = NULL;
        srclen = 0;
    }
    OPENSSL_free(*pdest);
    *pdest = tmp;
    if (pdestlen != NULL)
        *pdestlen = srclen;
    return 1;
}

int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
{
    OPENSSL_free(param->name);
    param->name = OPENSSL_strdup(name);
    return param->name != NULL;
}

int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
{
    param->flags |= flags;
    if ((flags & X509_V_FLAG_POLICY_MASK) != 0)
        param->flags |= X509_V_FLAG_POLICY_CHECK;
    return 1;
}

int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
    unsigned long flags)
{
    param->flags &= ~flags;
    return 1;
}

unsigned long X509_VERIFY_PARAM_get_flags(const X509_VERIFY_PARAM *param)
{
    return param->flags;
}

uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM *param)
{
    return param->inh_flags;
}

int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM *param, uint32_t flags)
{
    param->inh_flags = flags;
    return 1;
}

/* resets to default (any) purpose if |purpose| == X509_PURPOSE_DEFAULT_ANY */
int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
{
    return X509_PURPOSE_set(&param->purpose, purpose);
}

int X509_VERIFY_PARAM_get_purpose(const X509_VERIFY_PARAM *param)
{
    return param->purpose;
}

int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
{
    return X509_TRUST_set(&param->trust, trust);
}

void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
{
    param->depth = depth;
}

void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level)
{
    param->auth_level = auth_level;
}

time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM *param)
{
    /* This will be in the time_t range, because the only setter uses time_t */
    return (time_t)param->check_time;
}

void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
{
    param->check_time = (int64_t)t;
    param->flags |= X509_V_FLAG_USE_CHECK_TIME;
}

void ossl_x509_verify_param_set_time_posix(X509_VERIFY_PARAM *param, int64_t t)
{
    param->check_time = t;
    param->flags |= X509_V_FLAG_USE_CHECK_TIME;
}

int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
    ASN1_OBJECT *policy)
{
    if (param->policies == NULL) {
        param->policies = sk_ASN1_OBJECT_new_null();
        if (param->policies == NULL)
            return 0;
    }

    if (sk_ASN1_OBJECT_push(param->policies, policy) <= 0)
        return 0;
    return 1;
}

int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
    STACK_OF(ASN1_OBJECT) *policies)
{
    int i;
    ASN1_OBJECT *oid, *doid;

    if (param == NULL) {
        ERR_raise(ERR_LIB_X509, ERR_R_PASSED_NULL_PARAMETER);
        return 0;
    }
    sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);

    if (policies == NULL) {
        param->policies = NULL;
        return 1;
    }

    param->policies = sk_ASN1_OBJECT_new_null();
    if (param->policies == NULL)
        return 0;

    for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
        oid = sk_ASN1_OBJECT_value(policies, i);
        doid = OBJ_dup(oid);
        if (doid == NULL)
            return 0;
        if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
            ASN1_OBJECT_free(doid);
            return 0;
        }
    }
    param->flags |= X509_V_FLAG_POLICY_CHECK;
    return 1;
}

char *X509_VERIFY_PARAM_get0_host(X509_VERIFY_PARAM *param, int idx)
{
    return sk_OPENSSL_STRING_value(param->hosts, idx);
}

int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
    const char *name, size_t namelen)
{
    return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
}

int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
    const char *name, size_t namelen)
{
    return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
}

void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
    unsigned int flags)
{
    param->hostflags = flags;
}

unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param)
{
    return param->hostflags;
}

char *X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM *param)
{
    return param->peername;
}

/*
 * Move peername from one param structure to another, freeing any name present
 * at the target.  If the source is a NULL parameter structure, free and zero
 * the target peername.
 */
void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
    X509_VERIFY_PARAM *from)
{
    char *peername = (from != NULL) ? from->peername : NULL;

    if (to->peername != peername) {
        OPENSSL_free(to->peername);
        to->peername = peername;
    }
    if (from != NULL)
        from->peername = NULL;
}

char *X509_VERIFY_PARAM_get0_email(X509_VERIFY_PARAM *param)
{
    return param->email;
}

int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
    const char *email, size_t emaillen)
{
    return int_x509_param_set1(&param->email, &param->emaillen,
        email, emaillen);
}

static unsigned char *int_X509_VERIFY_PARAM_get0_ip(X509_VERIFY_PARAM *param, size_t *plen)
{
    if (param == NULL || param->ip == NULL) {
        ERR_raise(ERR_LIB_X509, ERR_R_PASSED_NULL_PARAMETER);
        return NULL;
    }
    if (plen != NULL)
        *plen = param->iplen;
    return param->ip;
}

char *X509_VERIFY_PARAM_get1_ip_asc(X509_VERIFY_PARAM *param)
{
    size_t iplen;
    unsigned char *ip = int_X509_VERIFY_PARAM_get0_ip(param, &iplen);

    return ip == NULL ? NULL : ossl_ipaddr_to_asc(ip, (int)iplen);
}

int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
    const unsigned char *ip, size_t iplen)
{
    if (iplen != 0 && iplen != 4 && iplen != 16) {
        ERR_raise(ERR_LIB_X509, ERR_R_PASSED_INVALID_ARGUMENT);
        return 0;
    }
    return int_x509_param_set1((char **)&param->ip, &param->iplen,
        (char *)ip, iplen);
}

int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
{
    unsigned char ipout[16];
    size_t iplen = (size_t)ossl_a2i_ipadd(ipout, ipasc);

    if (iplen == 0)
        return 0;
    return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
}

int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
{
    return param->depth;
}

int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
{
    return param->auth_level;
}

const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
{
    return param->name;
}

#define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0

/*
 * Default verify parameters: these are used for various applications and can
 * be overridden by the user specified table. NB: the 'name' field *must* be
 * in alphabetical order because it will be searched using OBJ_search.
 */

static const X509_VERIFY_PARAM default_table[] = {
    { "code_sign", /* Code sign parameters */
        0, /* check time to use */
        0, /* inheritance flags */
        0, /* flags */
        X509_PURPOSE_CODE_SIGN, /* purpose */
        X509_TRUST_OBJECT_SIGN, /* trust */
        -1, /* depth */
        -1, /* auth_level */
        NULL, /* policies */
        vpm_empty_id },
    { "default", /* X509 default parameters */
        0, /* check time to use */
        0, /* inheritance flags */
        X509_V_FLAG_TRUSTED_FIRST, /* flags */
        0, /* purpose */
        0, /* trust */
        100, /* depth */
        -1, /* auth_level */
        NULL, /* policies */
        vpm_empty_id },
    { "pkcs7", /* S/MIME sign parameters */
        0, /* check time to use */
        0, /* inheritance flags */
        0, /* flags */
        X509_PURPOSE_SMIME_SIGN, /* purpose */
        X509_TRUST_EMAIL, /* trust */
        -1, /* depth */
        -1, /* auth_level */
        NULL, /* policies */
        vpm_empty_id },
    { "smime_sign", /* S/MIME sign parameters */
        0, /* check time to use */
        0, /* inheritance flags */
        0, /* flags */
        X509_PURPOSE_SMIME_SIGN, /* purpose */
        X509_TRUST_EMAIL, /* trust */
        -1, /* depth */
        -1, /* auth_level */
        NULL, /* policies */
        vpm_empty_id },
    { "ssl_client", /* SSL/TLS client parameters */
        0, /* check time to use */
        0, /* inheritance flags */
        0, /* flags */
        X509_PURPOSE_SSL_CLIENT, /* purpose */
        X509_TRUST_SSL_CLIENT, /* trust */
        -1, /* depth */
        -1, /* auth_level */
        NULL, /* policies */
        vpm_empty_id },
    { "ssl_server", /* SSL/TLS server parameters */
        0, /* check time to use */
        0, /* inheritance flags */
        0, /* flags */
        X509_PURPOSE_SSL_SERVER, /* purpose */
        X509_TRUST_SSL_SERVER, /* trust */
        -1, /* depth */
        -1, /* auth_level */
        NULL, /* policies */
        vpm_empty_id }
};

static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;

static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
{
    return strcmp(a->name, b->name);
}

DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);

static int param_cmp(const X509_VERIFY_PARAM *const *a,
    const X509_VERIFY_PARAM *const *b)
{
    return strcmp((*a)->name, (*b)->name);
}

int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
{
    int idx;
    X509_VERIFY_PARAM *ptmp;

    if (param_table == NULL) {
        param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
        if (param_table == NULL)
            return 0;
    } else {
        idx = sk_X509_VERIFY_PARAM_find(param_table, param);
        if (idx >= 0) {
            ptmp = sk_X509_VERIFY_PARAM_delete(param_table, idx);
            X509_VERIFY_PARAM_free(ptmp);
        }
    }

    if (sk_X509_VERIFY_PARAM_push(param_table, param) <= 0)
        return 0;
    return 1;
}

int X509_VERIFY_PARAM_get_count(void)
{
    int num = OSSL_NELEM(default_table);

    if (param_table != NULL)
        num += sk_X509_VERIFY_PARAM_num(param_table);
    return num;
}

const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
{
    int num = OSSL_NELEM(default_table);

    if (id < 0) {
        ERR_raise(ERR_LIB_X509, ERR_R_PASSED_INVALID_ARGUMENT);
        return NULL;
    }

    if (id < num)
        return default_table + id;
    return sk_X509_VERIFY_PARAM_value(param_table, id - num);
}

const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
{
    int idx;
    X509_VERIFY_PARAM pm;

    pm.name = (char *)name;
    if (param_table != NULL) {
        /* Ideally, this would be done under a lock */
        sk_X509_VERIFY_PARAM_sort(param_table);
        idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
        if (idx >= 0)
            return sk_X509_VERIFY_PARAM_value(param_table, idx);
    }
    return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
}

void X509_VERIFY_PARAM_table_cleanup(void)
{
    sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
    param_table = NULL;
}

Coverage Report

Created: 2025-12-10 06:24

Line	Count	Source
1		/*
2		* Copyright 2004-2025 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		#include <stdio.h>
11
12		#include "internal/cryptlib.h"
13		#include <openssl/crypto.h>
14		#include <openssl/buffer.h>
15		#include <openssl/x509.h>
16		#include <openssl/x509v3.h>
17		#include "crypto/x509.h"
18
19		#include "x509_local.h"
20
21		/* X509_VERIFY_PARAM functions */
22
23	0	#define SET_HOST 0
24	0	#define ADD_HOST 1
25
26		static char str_copy(const char s)
27	0	{
28	0	return OPENSSL_strdup(s);
29	0	}
30
31		static void str_free(char *s)
32	0	{
33	0	OPENSSL_free(s);
34	0	}
35
36		static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
37		const char *name, size_t namelen)
38	0	{
39	0	char *copy;
40
41		/*
42		* Refuse names with embedded NUL bytes, except perhaps as final byte.
43		* XXX: Do we need to push an error onto the error stack?
44		*/
45	0	if (namelen == 0 \|\| name == NULL)
46	0	namelen = name ? strlen(name) : 0;
47	0	else if (name != NULL
48	0	&& memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen) != NULL)
49	0	return 0;
50	0	if (namelen > 0 && name[namelen - 1] == '\0')
51	0	--namelen;
52
53	0	if (mode == SET_HOST) {
54	0	sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
55	0	vpm->hosts = NULL;
56	0	}
57	0	if (name == NULL \|\| namelen == 0)
58	0	return 1;
59
60	0	copy = OPENSSL_strndup(name, namelen);
61	0	if (copy == NULL)
62	0	return 0;
63
64	0	if (vpm->hosts == NULL && (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
65	0	OPENSSL_free(copy);
66	0	return 0;
67	0	}
68
69	0	if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
70	0	OPENSSL_free(copy);
71	0	if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
72	0	sk_OPENSSL_STRING_free(vpm->hosts);
73	0	vpm->hosts = NULL;
74	0	}
75	0	return 0;
76	0	}
77
78	0	return 1;
79	0	}
80
81		X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
82	0	{
83	0	X509_VERIFY_PARAM *param;
84
85	0	param = OPENSSL_zalloc(sizeof(*param));
86	0	if (param == NULL)
87	0	return NULL;
88	0	param->trust = X509_TRUST_DEFAULT;
89		/* param->inh_flags = X509_VP_FLAG_DEFAULT; */
90	0	param->depth = -1;
91	0	param->auth_level = -1; /* -1 means unset, 0 is explicit */
92	0	return param;
93	0	}
94
95		void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
96	0	{
97	0	if (param == NULL)
98	0	return;
99	0	sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
100	0	sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
101	0	OPENSSL_free(param->peername);
102	0	OPENSSL_free(param->email);
103	0	OPENSSL_free(param->ip);
104	0	OPENSSL_free(param);
105	0	}
106
107		/*-
108		* This function determines how parameters are "inherited" from one structure
109		* to another. There are several different ways this can happen.
110		*
111		* 1. If a child structure needs to have its values initialized from a parent
112		* they are simply copied across. For example SSL_CTX copied to SSL.
113		* 2. If the structure should take on values only if they are currently unset.
114		* For example the values in an SSL structure will take appropriate value
115		* for SSL servers or clients but only if the application has not set new
116		* ones.
117		*
118		* The "inh_flags" field determines how this function behaves.
119		*
120		* Normally any values which are set in the default are not copied from the
121		* destination and verify flags are ORed together.
122		*
123		* If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
124		* to the destination. Effectively the values in "to" become default values
125		* which will be used only if nothing new is set in "from".
126		*
127		* If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
128		* they are set or not. Flags is still Ored though.
129		*
130		* If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
131		* of ORed.
132		*
133		* If X509_VP_FLAG_LOCKED is set then no values are copied.
134		*
135		* If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
136		* after the next call.
137		*/
138
139		/* Macro to test if a field should be copied from src to dest */
140
141		#define test_x509_verify_param_copy(field, def) \
142	0	(to_overwrite \|\| (src->field != def && (to_default \|\| dest->field == def)))
143
144		/* Macro to test and copy a field if necessary */
145
146		#define x509_verify_param_copy(field, def) \
147	0	if (test_x509_verify_param_copy(field, def)) \
148	0	dest->field = src->field;
149
150		int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
151		const X509_VERIFY_PARAM *src)
152	0	{
153	0	unsigned long inh_flags;
154	0	int to_default, to_overwrite;
155
156	0	if (src == NULL)
157	0	return 1;
158	0	inh_flags = dest->inh_flags \| src->inh_flags;
159
160	0	if ((inh_flags & X509_VP_FLAG_ONCE) != 0)
161	0	dest->inh_flags = 0;
162
163	0	if ((inh_flags & X509_VP_FLAG_LOCKED) != 0)
164	0	return 1;
165
166	0	to_default = (inh_flags & X509_VP_FLAG_DEFAULT) != 0;
167	0	to_overwrite = (inh_flags & X509_VP_FLAG_OVERWRITE) != 0;
168
169	0	x509_verify_param_copy(purpose, 0);
170	0	x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
171	0	x509_verify_param_copy(depth, -1);
172	0	x509_verify_param_copy(auth_level, -1);
173
174		/* If overwrite or check time not set, copy across */
175
176	0	if (to_overwrite \|\| (dest->flags & X509_V_FLAG_USE_CHECK_TIME) == 0) {
177	0	dest->check_time = src->check_time;
178	0	dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
179		/* Don't need to copy flag: that is done below */
180	0	}
181
182	0	if ((inh_flags & X509_VP_FLAG_RESET_FLAGS) != 0)
183	0	dest->flags = 0;
184
185	0	dest->flags \|= src->flags;
186
187	0	if (test_x509_verify_param_copy(policies, NULL)) {
188	0	if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
189	0	return 0;
190	0	}
191
192	0	x509_verify_param_copy(hostflags, 0);
193
194	0	if (test_x509_verify_param_copy(hosts, NULL)) {
195	0	sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
196	0	dest->hosts = NULL;
197	0	if (src->hosts != NULL) {
198	0	dest->hosts = sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
199	0	if (dest->hosts == NULL)
200	0	return 0;
201	0	}
202	0	}
203
204	0	if (test_x509_verify_param_copy(email, NULL)) {
205	0	if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
206	0	return 0;
207	0	}
208
209	0	if (test_x509_verify_param_copy(ip, NULL)) {
210	0	if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
211	0	return 0;
212	0	}
213
214	0	return 1;
215	0	}
216
217		int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
218		const X509_VERIFY_PARAM *from)
219	0	{
220	0	unsigned long save_flags;
221	0	int ret;
222
223	0	if (to == NULL) {
224	0	ERR_raise(ERR_LIB_X509, ERR_R_PASSED_NULL_PARAMETER);
225	0	return 0;
226	0	}
227	0	save_flags = to->inh_flags;
228	0	to->inh_flags \|= X509_VP_FLAG_DEFAULT;
229	0	ret = X509_VERIFY_PARAM_inherit(to, from);
230	0	to->inh_flags = save_flags;
231	0	return ret;
232	0	}
233
234		static int int_x509_param_set1(char *pdest, size_t pdestlen,
235		const char *src, size_t srclen)
236	0	{
237	0	char *tmp;
238
239	0	if (src != NULL) {
240	0	if (srclen == 0)
241	0	srclen = strlen(src);
242
243	0	tmp = OPENSSL_malloc(srclen + 1);
244	0	if (tmp == NULL)
245	0	return 0;
246	0	memcpy(tmp, src, srclen);
247	0	tmp[srclen] = '\0'; /* enforce NUL termination */
248	0	} else {
249	0	tmp = NULL;
250	0	srclen = 0;
251	0	}
252	0	OPENSSL_free(*pdest);
253	0	*pdest = tmp;
254	0	if (pdestlen != NULL)
255	0	*pdestlen = srclen;
256	0	return 1;
257	0	}
258
259		int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM param, const char name)
260	0	{
261	0	OPENSSL_free(param->name);
262	0	param->name = OPENSSL_strdup(name);
263	0	return param->name != NULL;
264	0	}
265
266		int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
267	0	{
268	0	param->flags \|= flags;
269	0	if ((flags & X509_V_FLAG_POLICY_MASK) != 0)
270	0	param->flags \|= X509_V_FLAG_POLICY_CHECK;
271	0	return 1;
272	0	}
273
274		int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
275		unsigned long flags)
276	0	{
277	0	param->flags &= ~flags;
278	0	return 1;
279	0	}
280
281		unsigned long X509_VERIFY_PARAM_get_flags(const X509_VERIFY_PARAM *param)
282	0	{
283	0	return param->flags;
284	0	}
285
286		uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM *param)
287	0	{
288	0	return param->inh_flags;
289	0	}
290
291		int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM *param, uint32_t flags)
292	0	{
293	0	param->inh_flags = flags;
294	0	return 1;
295	0	}
296
297		/* resets to default (any) purpose if \|purpose\| == X509_PURPOSE_DEFAULT_ANY */
298		int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
299	0	{
300	0	return X509_PURPOSE_set(&param->purpose, purpose);
301	0	}
302
303		int X509_VERIFY_PARAM_get_purpose(const X509_VERIFY_PARAM *param)
304	0	{
305	0	return param->purpose;
306	0	}
307
308		int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
309	0	{
310	0	return X509_TRUST_set(&param->trust, trust);
311	0	}
312
313		void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
314	0	{
315	0	param->depth = depth;
316	0	}
317
318		void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level)
319	0	{
320	0	param->auth_level = auth_level;
321	0	}
322
323		time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM *param)
324	0	{
325		/* This will be in the time_t range, because the only setter uses time_t */
326	0	return (time_t)param->check_time;
327	0	}
328
329		void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
330	0	{
331	0	param->check_time = (int64_t)t;
332	0	param->flags \|= X509_V_FLAG_USE_CHECK_TIME;
333	0	}
334
335		void ossl_x509_verify_param_set_time_posix(X509_VERIFY_PARAM *param, int64_t t)
336	0	{
337	0	param->check_time = t;
338	0	param->flags \|= X509_V_FLAG_USE_CHECK_TIME;
339	0	}
340
341		int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
342		ASN1_OBJECT *policy)
343	0	{
344	0	if (param->policies == NULL) {
345	0	param->policies = sk_ASN1_OBJECT_new_null();
346	0	if (param->policies == NULL)
347	0	return 0;
348	0	}
349
350	0	if (sk_ASN1_OBJECT_push(param->policies, policy) <= 0)
351	0	return 0;
352	0	return 1;
353	0	}
354
355		int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
356		STACK_OF(ASN1_OBJECT) *policies)
357	0	{
358	0	int i;
359	0	ASN1_OBJECT oid, doid;
360
361	0	if (param == NULL) {
362	0	ERR_raise(ERR_LIB_X509, ERR_R_PASSED_NULL_PARAMETER);
363	0	return 0;
364	0	}
365	0	sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
366
367	0	if (policies == NULL) {
368	0	param->policies = NULL;
369	0	return 1;
370	0	}
371
372	0	param->policies = sk_ASN1_OBJECT_new_null();
373	0	if (param->policies == NULL)
374	0	return 0;
375
376	0	for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
377	0	oid = sk_ASN1_OBJECT_value(policies, i);
378	0	doid = OBJ_dup(oid);
379	0	if (doid == NULL)
380	0	return 0;
381	0	if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
382	0	ASN1_OBJECT_free(doid);
383	0	return 0;
384	0	}
385	0	}
386	0	param->flags \|= X509_V_FLAG_POLICY_CHECK;
387	0	return 1;
388	0	}
389
390		char X509_VERIFY_PARAM_get0_host(X509_VERIFY_PARAM param, int idx)
391	0	{
392	0	return sk_OPENSSL_STRING_value(param->hosts, idx);
393	0	}
394
395		int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
396		const char *name, size_t namelen)
397	0	{
398	0	return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
399	0	}
400
401		int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
402		const char *name, size_t namelen)
403	0	{
404	0	return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
405	0	}
406
407		void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
408		unsigned int flags)
409	0	{
410	0	param->hostflags = flags;
411	0	}
412
413		unsigned int X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param)
414	0	{
415	0	return param->hostflags;
416	0	}
417
418		char X509_VERIFY_PARAM_get0_peername(const X509_VERIFY_PARAM param)
419	0	{
420	0	return param->peername;
421	0	}
422
423		/*
424		* Move peername from one param structure to another, freeing any name present
425		* at the target. If the source is a NULL parameter structure, free and zero
426		* the target peername.
427		*/
428		void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
429		X509_VERIFY_PARAM *from)
430	0	{
431	0	char *peername = (from != NULL) ? from->peername : NULL;
432
433	0	if (to->peername != peername) {
434	0	OPENSSL_free(to->peername);
435	0	to->peername = peername;
436	0	}
437	0	if (from != NULL)
438	0	from->peername = NULL;
439	0	}
440
441		char X509_VERIFY_PARAM_get0_email(X509_VERIFY_PARAM param)
442	0	{
443	0	return param->email;
444	0	}
445
446		int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
447		const char *email, size_t emaillen)
448	0	{
449	0	return int_x509_param_set1(&param->email, &param->emaillen,
450	0	email, emaillen);
451	0	}
452
453		static unsigned char int_X509_VERIFY_PARAM_get0_ip(X509_VERIFY_PARAM param, size_t *plen)
454	0	{
455	0	if (param == NULL \|\| param->ip == NULL) {
456	0	ERR_raise(ERR_LIB_X509, ERR_R_PASSED_NULL_PARAMETER);
457	0	return NULL;
458	0	}
459	0	if (plen != NULL)
460	0	*plen = param->iplen;
461	0	return param->ip;
462	0	}
463
464		char X509_VERIFY_PARAM_get1_ip_asc(X509_VERIFY_PARAM param)
465	0	{
466	0	size_t iplen;
467	0	unsigned char *ip = int_X509_VERIFY_PARAM_get0_ip(param, &iplen);
468
469	0	return ip == NULL ? NULL : ossl_ipaddr_to_asc(ip, (int)iplen);
470	0	}
471
472		int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
473		const unsigned char *ip, size_t iplen)
474	0	{
475	0	if (iplen != 0 && iplen != 4 && iplen != 16) {
476	0	ERR_raise(ERR_LIB_X509, ERR_R_PASSED_INVALID_ARGUMENT);
477	0	return 0;
478	0	}
479	0	return int_x509_param_set1((char **)&param->ip, &param->iplen,
480	0	(char *)ip, iplen);
481	0	}
482
483		int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM param, const char ipasc)
484	0	{
485	0	unsigned char ipout[16];
486	0	size_t iplen = (size_t)ossl_a2i_ipadd(ipout, ipasc);
487
488	0	if (iplen == 0)
489	0	return 0;
490	0	return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
491	0	}
492
493		int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
494	0	{
495	0	return param->depth;
496	0	}
497
498		int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
499	0	{
500	0	return param->auth_level;
501	0	}
502
503		const char X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM param)
504	0	{
505	0	return param->name;
506	0	}
507
508		#define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
509
510		/*
511		* Default verify parameters: these are used for various applications and can
512		* be overridden by the user specified table. NB: the 'name' field must be
513		* in alphabetical order because it will be searched using OBJ_search.
514		*/
515
516		static const X509_VERIFY_PARAM default_table[] = {
517		{ "code_sign", /* Code sign parameters */
518		0, /* check time to use */
519		0, /* inheritance flags */
520		0, /* flags */
521		X509_PURPOSE_CODE_SIGN, /* purpose */
522		X509_TRUST_OBJECT_SIGN, /* trust */
523		-1, /* depth */
524		-1, /* auth_level */
525		NULL, /* policies */
526		vpm_empty_id },
527		{ "default", /* X509 default parameters */
528		0, /* check time to use */
529		0, /* inheritance flags */
530		X509_V_FLAG_TRUSTED_FIRST, /* flags */
531		0, /* purpose */
532		0, /* trust */
533		100, /* depth */
534		-1, /* auth_level */
535		NULL, /* policies */
536		vpm_empty_id },
537		{ "pkcs7", /* S/MIME sign parameters */
538		0, /* check time to use */
539		0, /* inheritance flags */
540		0, /* flags */
541		X509_PURPOSE_SMIME_SIGN, /* purpose */
542		X509_TRUST_EMAIL, /* trust */
543		-1, /* depth */
544		-1, /* auth_level */
545		NULL, /* policies */
546		vpm_empty_id },
547		{ "smime_sign", /* S/MIME sign parameters */
548		0, /* check time to use */
549		0, /* inheritance flags */
550		0, /* flags */
551		X509_PURPOSE_SMIME_SIGN, /* purpose */
552		X509_TRUST_EMAIL, /* trust */
553		-1, /* depth */
554		-1, /* auth_level */
555		NULL, /* policies */
556		vpm_empty_id },
557		{ "ssl_client", /* SSL/TLS client parameters */
558		0, /* check time to use */
559		0, /* inheritance flags */
560		0, /* flags */
561		X509_PURPOSE_SSL_CLIENT, /* purpose */
562		X509_TRUST_SSL_CLIENT, /* trust */
563		-1, /* depth */
564		-1, /* auth_level */
565		NULL, /* policies */
566		vpm_empty_id },
567		{ "ssl_server", /* SSL/TLS server parameters */
568		0, /* check time to use */
569		0, /* inheritance flags */
570		0, /* flags */
571		X509_PURPOSE_SSL_SERVER, /* purpose */
572		X509_TRUST_SSL_SERVER, /* trust */
573		-1, /* depth */
574		-1, /* auth_level */
575		NULL, /* policies */
576		vpm_empty_id }
577		};
578
579		static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
580
581		static int table_cmp(const X509_VERIFY_PARAM a, const X509_VERIFY_PARAM b)
582	0	{
583	0	return strcmp(a->name, b->name);
584	0	}
585
586		DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
587		IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
588
589		static int param_cmp(const X509_VERIFY_PARAM const a,
590		const X509_VERIFY_PARAM const b)
591	0	{
592	0	return strcmp((a)->name, (b)->name);
593	0	}
594
595		int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
596	0	{
597	0	int idx;
598	0	X509_VERIFY_PARAM *ptmp;
599
600	0	if (param_table == NULL) {
601	0	param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
602	0	if (param_table == NULL)
603	0	return 0;
604	0	} else {
605	0	idx = sk_X509_VERIFY_PARAM_find(param_table, param);
606	0	if (idx >= 0) {
607	0	ptmp = sk_X509_VERIFY_PARAM_delete(param_table, idx);
608	0	X509_VERIFY_PARAM_free(ptmp);
609	0	}
610	0	}
611
612	0	if (sk_X509_VERIFY_PARAM_push(param_table, param) <= 0)
613	0	return 0;
614	0	return 1;
615	0	}
616
617		int X509_VERIFY_PARAM_get_count(void)
618	0	{
619	0	int num = OSSL_NELEM(default_table);
620
621	0	if (param_table != NULL)
622	0	num += sk_X509_VERIFY_PARAM_num(param_table);
623	0	return num;
624	0	}
625
626		const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
627	0	{
628	0	int num = OSSL_NELEM(default_table);
629
630	0	if (id < 0) {
631	0	ERR_raise(ERR_LIB_X509, ERR_R_PASSED_INVALID_ARGUMENT);
632	0	return NULL;
633	0	}
634
635	0	if (id < num)
636	0	return default_table + id;
637	0	return sk_X509_VERIFY_PARAM_value(param_table, id - num);
638	0	}
639
640		const X509_VERIFY_PARAM X509_VERIFY_PARAM_lookup(const char name)
641	0	{
642	0	int idx;
643	0	X509_VERIFY_PARAM pm;
644
645	0	pm.name = (char *)name;
646	0	if (param_table != NULL) {
647		/* Ideally, this would be done under a lock */
648	0	sk_X509_VERIFY_PARAM_sort(param_table);
649	0	idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
650	0	if (idx >= 0)
651	0	return sk_X509_VERIFY_PARAM_value(param_table, idx);
652	0	}
653	0	return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
654	0	}
655
656		void X509_VERIFY_PARAM_table_cleanup(void)
657	0	{
658	0	sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
659		param_table = NULL;
660	0	}