Commit 195852fe authored by Richard Levitte's avatar Richard Levitte
Browse files

Params: add OSSL_PARAM_construct_end() 



OSSL_PARAM_END is a macro that can only be used to initialize an
OSSL_PARAM array, not to assign an array element later on.  For
completion, we add an end constructor to facilitate that kind of
assignment.

Reviewed-by: default avatarPaul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/8704)
parent bb315ca7

crypto/params.c

+7 −0
Original line number Diff line number Diff line
@@ -590,3 +590,10 @@ OSSL_PARAM OSSL_PARAM_construct_octet_ptr(const char *key, void **buf, 
{

    return ossl_param_construct(key, OSSL_PARAM_OCTET_PTR, buf, 0, rsize);

}



OSSL_PARAM OSSL_PARAM_construct_end(void)

{

    OSSL_PARAM end = OSSL_PARAM_END;



    return end;

}

doc/man3/OSSL_PARAM_TYPE.pod

+6 −1
Original line number Diff line number Diff line
@@ -10,7 +10,8 @@ OSSL_PARAM_SIZED_octet_ptr, OSSL_PARAM_END, OSSL_PARAM_construct_TYPE, 
OSSL_PARAM_END,

OSSL_PARAM_construct_BN, OSSL_PARAM_construct_utf8_string,

OSSL_PARAM_construct_utf8_ptr, OSSL_PARAM_construct_octet_string,

OSSL_PARAM_construct_octet_ptr, OSSL_PARAM_locate, OSSL_PARAM_get_TYPE,

OSSL_PARAM_construct_octet_ptr, OSSL_PARAM_construct_end,

OSSL_PARAM_locate, OSSL_PARAM_get_TYPE,

OSSL_PARAM_set_TYPE, OSSL_PARAM_get_BN, OSSL_PARAM_set_BN,

OSSL_PARAM_get_utf8_string, OSSL_PARAM_set_utf8_string,

OSSL_PARAM_get_octet_string, OSSL_PARAM_set_octet_string,
@@ -46,6 +47,7 @@ OSSL_PARAM_set_octet_ptr 
                                          size_t *rsize);

 OSSL_PARAM OSSL_PARAM_construct_octet_ptr(const char *key, void **buf,

                                           size_t *rsize);

 OSSL_PARAM OSSL_PARAM_construct_end(void);



 OSSL_PARAM *OSSL_PARAM_locate(OSSL_PARAM *array, const char *key);
@@ -179,6 +181,9 @@ pointer OSSL_PARAM structure. 
A parameter with name B<key>, storage pointer B<*buf> and return size B<rsize>

is created.



OSSL_PARAM_construct_end() is a function that constructs the terminating

OSSL_PARAM structure.



OSSL_PARAM_locate() is a function that searches an B<array> of parameters for

the one matching the B<key> name.

include/openssl/params.h

+1 −0
Original line number Diff line number Diff line
@@ -137,6 +137,7 @@ OSSL_PARAM OSSL_PARAM_construct_octet_string(const char *key, void *buf, 
                                             size_t bsize, size_t *rsize);

OSSL_PARAM OSSL_PARAM_construct_octet_ptr(const char *key, void **buf,

                                          size_t *rsize);

OSSL_PARAM OSSL_PARAM_construct_end(void);



int OSSL_PARAM_get_int(const OSSL_PARAM *p, int *val);

int OSSL_PARAM_get_uint(const OSSL_PARAM *p, unsigned int *val);

test/params_api_test.c

+1 −2
Original line number Diff line number Diff line
@@ -448,7 +448,6 @@ static int test_param_construct(void) 
    void *vp, *vpn = NULL, *vp2;

    OSSL_PARAM *p;

    const OSSL_PARAM *cp;

    static const OSSL_PARAM pend = OSSL_PARAM_END;

    int i, n = 0, ret = 0;

    unsigned int u;

    long int l;
@@ -478,7 +477,7 @@ static int test_param_construct(void) 
                                                    &sz);

    params[n++] = OSSL_PARAM_construct_utf8_ptr("utf8ptr", &bufp, &sz);

    params[n++] = OSSL_PARAM_construct_octet_ptr("octptr", &vp, &sz);

    params[n] = pend;

    params[n] = OSSL_PARAM_construct_end();



    /* Search failure */

    if (!TEST_ptr_null(OSSL_PARAM_locate(params, "fnord")))

test/params_test.c

+1 −2
Original line number Diff line number Diff line
@@ -391,7 +391,6 @@ static OSSL_PARAM *construct_api_params(void) 
{

    size_t n = 0;

    static OSSL_PARAM params[10];

    OSSL_PARAM param_end = OSSL_PARAM_END;



    params[n++] = OSSL_PARAM_construct_int("p1", &app_p1, NULL);

    params[n++] = OSSL_PARAM_construct_BN("p3", bignumbin, sizeof(bignumbin),
@@ -404,7 +403,7 @@ static OSSL_PARAM *construct_api_params(void) 
                                                &app_p6_l);

    params[n++] = OSSL_PARAM_construct_octet_string("foo", &foo, sizeof(foo),

                                                    &foo_l);

    params[n++] = param_end;

    params[n++] = OSSL_PARAM_construct_end();



    return params;

}