Commit de4d764e authored by Matt Caswell's avatar Matt Caswell
Browse files

Rename the Elliptic Curves extension to supported_groups 



This is a skin deep change, which simply renames most places where we talk
about curves in a TLS context to groups. This is because TLS1.3 has renamed
the extension, and it can now include DH groups too. We still only support
curves, but this rename should pave the way for a future extension for DH
groups.

Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
parent cf551a51

apps/s_apps.h

+1 −1
Original line number Diff line number Diff line
@@ -59,7 +59,7 @@ int set_cert_key_stuff(SSL_CTX *ctx, X509 *cert, EVP_PKEY *key, 
                       STACK_OF(X509) *chain, int build_chain);

int ssl_print_sigalgs(BIO *out, SSL *s);

int ssl_print_point_formats(BIO *out, SSL *s);

int ssl_print_curves(BIO *out, SSL *s, int noshared);

int ssl_print_groups(BIO *out, SSL *s, int noshared);

#endif

int ssl_print_tmp_key(BIO *out, SSL *s);

int init_client(int *sock, const char *host, const char *port,

apps/s_cb.c

+28 −26
Original line number Diff line number Diff line
@@ -307,50 +307,52 @@ int ssl_print_point_formats(BIO *out, SSL *s) 
    return 1;

}



int ssl_print_curves(BIO *out, SSL *s, int noshared)

int ssl_print_groups(BIO *out, SSL *s, int noshared)

{

    int i, ncurves, *curves, nid;

    const char *cname;

    int i, ngroups, *groups, nid;

    const char *gname;



    ncurves = SSL_get1_curves(s, NULL);

    if (ncurves <= 0)

    ngroups = SSL_get1_groups(s, NULL);

    if (ngroups <= 0)

        return 1;

    curves = app_malloc(ncurves * sizeof(int), "curves to print");

    SSL_get1_curves(s, curves);

    groups = app_malloc(ngroups * sizeof(int), "groups to print");

    SSL_get1_groups(s, groups);



    BIO_puts(out, "Supported Elliptic Curves: ");

    for (i = 0; i < ncurves; i++) {

    BIO_puts(out, "Supported Elliptic Groups: ");

    for (i = 0; i < ngroups; i++) {

        if (i)

            BIO_puts(out, ":");

        nid = curves[i];

        nid = groups[i];

        /* If unrecognised print out hex version */

        if (nid & TLSEXT_nid_unknown)

            BIO_printf(out, "0x%04X", nid & 0xFFFF);

        else {

            /* TODO(TLS1.3): Get group name here */

            /* Use NIST name for curve if it exists */

            cname = EC_curve_nid2nist(nid);

            if (!cname)

                cname = OBJ_nid2sn(nid);

            BIO_printf(out, "%s", cname);

            gname = EC_curve_nid2nist(nid);

            if (!gname)

                gname = OBJ_nid2sn(nid);

            BIO_printf(out, "%s", gname);

        }

    }

    OPENSSL_free(curves);

    OPENSSL_free(groups);

    if (noshared) {

        BIO_puts(out, "\n");

        return 1;

    }

    BIO_puts(out, "\nShared Elliptic curves: ");

    ncurves = SSL_get_shared_curve(s, -1);

    for (i = 0; i < ncurves; i++) {

    BIO_puts(out, "\nShared Elliptic groups: ");

    ngroups = SSL_get_shared_group(s, -1);

    for (i = 0; i < ngroups; i++) {

        if (i)

            BIO_puts(out, ":");

        nid = SSL_get_shared_curve(s, i);

        cname = EC_curve_nid2nist(nid);

        if (!cname)

            cname = OBJ_nid2sn(nid);

        BIO_printf(out, "%s", cname);

    }

    if (ncurves == 0)

        nid = SSL_get_shared_group(s, i);

        /* TODO(TLS1.3): Convert for DH groups */

        gname = EC_curve_nid2nist(nid);

        if (!gname)

            gname = OBJ_nid2sn(nid);

        BIO_printf(out, "%s", gname);

    }

    if (ngroups == 0)

        BIO_puts(out, "NONE");

    BIO_puts(out, "\n");

    return 1;
@@ -604,7 +606,7 @@ static STRINT_PAIR tlsext_types[] = { 
    {"client authz", TLSEXT_TYPE_client_authz},

    {"server authz", TLSEXT_TYPE_server_authz},

    {"cert type", TLSEXT_TYPE_cert_type},

    {"elliptic curves", TLSEXT_TYPE_elliptic_curves},

    {"supported_groups", TLSEXT_TYPE_supported_groups},

    {"EC point formats", TLSEXT_TYPE_ec_point_formats},

    {"SRP", TLSEXT_TYPE_srp},

    {"signature algorithms", TLSEXT_TYPE_signature_algorithms},
@@ -1093,7 +1095,7 @@ void print_ssl_summary(SSL *s) 
#ifndef OPENSSL_NO_EC

    ssl_print_point_formats(bio_err, s);

    if (SSL_is_server(s))

        ssl_print_curves(bio_err, s, 1);

        ssl_print_groups(bio_err, s, 1);

    else

        ssl_print_tmp_key(bio_err, s);

#else

apps/s_server.c

+2 −2
Original line number Diff line number Diff line
@@ -2560,7 +2560,7 @@ static int init_ssl_connection(SSL *con) 
    ssl_print_sigalgs(bio_s_out, con);

#ifndef OPENSSL_NO_EC

    ssl_print_point_formats(bio_s_out, con);

    ssl_print_curves(bio_s_out, con, 0);

    ssl_print_groups(bio_s_out, con, 0);

#endif

    BIO_printf(bio_s_out, "CIPHER is %s\n", (str != NULL) ? str : "(NONE)");
@@ -2847,7 +2847,7 @@ static int www_body(int s, int stype, unsigned char *context) 
            }

            ssl_print_sigalgs(io, con);

#ifndef OPENSSL_NO_EC

            ssl_print_curves(io, con, 0);

            ssl_print_groups(io, con, 0);

#endif

            BIO_printf(io, (SSL_session_reused(con)

                            ? "---\nReused, " : "---\nNew, "));

doc/man3/SSL_CTX_set1_curves.pod

+45 −26
Original line number Diff line number Diff line
@@ -2,13 +2,25 @@ 


=head1 NAME



SSL_CTX_set1_groups, SSL_CTX_set1_groups_list, SSL_set1_groups,

SSL_set1_groups_list, SSL_get1_groups, SSL_get_shared_group,

SSL_CTX_set1_curves, SSL_CTX_set1_curves_list, SSL_set1_curves,

SSL_set1_curves_list, SSL_get1_curves, SSL_get_shared_curve - EC supported curve functions

SSL_set1_curves_list, SSL_get1_curves, SSL_get_shared_curve

- EC supported curve functions



=head1 SYNOPSIS



 #include <openssl/ssl.h>



 int SSL_CTX_set1_groups(SSL_CTX *ctx, int *glist, int glistlen);

 int SSL_CTX_set1_groups_list(SSL_CTX *ctx, char *list);



 int SSL_set1_groups(SSL *ssl, int *glist, int glistlen);

 int SSL_set1_groups_list(SSL *ssl, char *list);



 int SSL_get1_groups(SSL *ssl, int *groups);

 int SSL_get_shared_group(SSL *s, int n);



 int SSL_CTX_set1_curves(SSL_CTX *ctx, int *clist, int clistlen);

 int SSL_CTX_set1_curves_list(SSL_CTX *ctx, char *list);
@@ -20,36 +32,42 @@ SSL_set1_curves_list, SSL_get1_curves, SSL_get_shared_curve - EC supported curve 


=head1 DESCRIPTION



SSL_CTX_set1_curves() sets the supported curves for B<ctx> to B<clistlen>

curves in the array B<clist>. The array consist of all NIDs of curves in

preference order. For a TLS client the curves are used directly in the

supported curves extension. For a TLS server the curves are used to

determine the set of shared curves.

SSL_CTX_set1_groups() sets the supported groups for B<ctx> to B<glistlen>

groups in the array B<glist>. The array consist of all NIDs of groups in

preference order. For a TLS client the groups are used directly in the

supported groups extension. For a TLS server the groups are used to

determine the set of shared groups.



SSL_CTX_set1_curves_list() sets the supported curves for B<ctx> to

string B<list>. The string is a colon separated list of curve NIDs or

SSL_CTX_set1_groups_list() sets the supported groups for B<ctx> to

string B<list>. The string is a colon separated list of group NIDs or

names, for example "P-521:P-384:P-256".



SSL_set1_curves() and SSL_set1_curves_list() are similar except they set

supported curves for the SSL structure B<ssl>.

SSL_set1_groups() and SSL_set1_groups_list() are similar except they set

supported groups for the SSL structure B<ssl>.



SSL_get1_curves() returns the set of supported curves sent by a client

in the supported curves extension. It returns the total number of

supported curves. The B<curves> parameter can be B<NULL> to simply

return the number of curves for memory allocation purposes. The

B<curves> array is in the form of a set of curve NIDs in preference

order. It can return zero if the client did not send a supported curves

SSL_get1_groups() returns the set of supported groups sent by a client

in the supported groups extension. It returns the total number of

supported groups. The B<groups> parameter can be B<NULL> to simply

return the number of groups for memory allocation purposes. The

B<groups> array is in the form of a set of group NIDs in preference

order. It can return zero if the client did not send a supported groups

extension.



SSL_get_shared_curve() returns shared curve B<n> for a server-side

SSL B<ssl>. If B<n> is -1 then the total number of shared curves is

SSL_get_shared_group() returns shared group B<n> for a server-side

SSL B<ssl>. If B<n> is -1 then the total number of shared groups is

returned, which may be zero. Other than for diagnostic purposes,

most applications will only be interested in the first shared curve

most applications will only be interested in the first shared group

so B<n> is normally set to zero. If the value B<n> is out of range,

NID_undef is returned.



All these functions are implemented as macros.



The curve functions are synonyms for the equivalently named group functions and

are identical in every respect. They exist because, prior to TLS1.3, there was

only the concept of supported curves. In TLS1.3 this was renamed to supported

groups, and extended to include Diffie Hellman groups. The group functions

should be used in preference.



=head1 NOTES



If an application wishes to make use of several of these functions for
@@ -58,16 +76,16 @@ consider using the SSL_CONF interface instead of manually parsing options. 


=head1 RETURN VALUES



SSL_CTX_set1_curves(), SSL_CTX_set1_curves_list(), SSL_set1_curves() and

SSL_set1_curves_list(), return 1 for success and 0 for failure.

SSL_CTX_set1_groups(), SSL_CTX_set1_groups_list(), SSL_set1_groups() and

SSL_set1_groups_list(), return 1 for success and 0 for failure.



SSL_get1_curves() returns the number of curves, which may be zero.

SSL_get1_groups() returns the number of groups, which may be zero.



SSL_get_shared_curve() returns the NID of shared curve B<n> or NID_undef if there

is no shared curve B<n>; or the total number of shared curves if B<n>

SSL_get_shared_group() returns the NID of shared group B<n> or NID_undef if there

is no shared group B<n>; or the total number of shared groups if B<n>

is -1.



When called on a client B<ssl>, SSL_get_shared_curve() has no meaning and

When called on a client B<ssl>, SSL_get_shared_group() has no meaning and

returns -1.



=head1 SEE ALSO
@@ -76,7 +94,8 @@ L<SSL_CTX_add_extra_chain_cert(3)> 


=head1 HISTORY



These functions were first added to OpenSSL 1.0.2.

The curve functions were first added to OpenSSL 1.0.2. The equivalent group

functions were first added to OpenSSL 1.1.1.



=head1 COPYRIGHT

include/openssl/ssl.h

+22 −10
Original line number Diff line number Diff line
@@ -1109,10 +1109,10 @@ DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION) 
# define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS        83

# define SSL_CTRL_CHAIN                          88

# define SSL_CTRL_CHAIN_CERT                     89

# define SSL_CTRL_GET_CURVES                     90

# define SSL_CTRL_SET_CURVES                     91

# define SSL_CTRL_SET_CURVES_LIST                92

# define SSL_CTRL_GET_SHARED_CURVE               93

# define SSL_CTRL_GET_GROUPS                     90

# define SSL_CTRL_SET_GROUPS                     91

# define SSL_CTRL_SET_GROUPS_LIST                92

# define SSL_CTRL_GET_SHARED_GROUP               93

# define SSL_CTRL_SET_SIGALGS                    97

# define SSL_CTRL_SET_SIGALGS_LIST               98

# define SSL_CTRL_CERT_FLAGS                     99
@@ -1227,18 +1227,30 @@ DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION) 
        SSL_ctrl(s,SSL_CTRL_SET_CHAIN_CERT_STORE,0,(char *)st)

# define SSL_set1_chain_cert_store(s,st) \

        SSL_ctrl(s,SSL_CTRL_SET_CHAIN_CERT_STORE,1,(char *)st)

# define SSL_get1_groups(ctx, s) \

        SSL_ctrl(ctx,SSL_CTRL_GET_GROUPS,0,(char *)s)

# define SSL_get1_curves(ctx, s) \

        SSL_ctrl(ctx,SSL_CTRL_GET_CURVES,0,(char *)s)

        SSL_get1_groups((ctx), (s))

# define SSL_CTX_set1_groups(ctx, glist, glistlen) \

        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_GROUPS,glistlen,(char *)glist)

# define SSL_CTX_set1_groups_list(ctx, s) \

        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_GROUPS_LIST,0,(char *)s)

# define SSL_CTX_set1_curves(ctx, clist, clistlen) \

        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CURVES,clistlen,(char *)clist)

        SSL_CTX_set1_groups((ctx), (clist), (clistlen))

# define SSL_CTX_set1_curves_list(ctx, s) \

        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CURVES_LIST,0,(char *)s)

        SSL_CTX_set1_groups_list((ctx), (s))

# define SSL_set1_groups(ctx, glist, glistlen) \

        SSL_ctrl(ctx,SSL_CTRL_SET_GROUPS,glistlen,(char *)glist)

# define SSL_set1_groups_list(ctx, s) \

        SSL_ctrl(ctx,SSL_CTRL_SET_GROUPS_LIST,0,(char *)s)

# define SSL_set1_curves(ctx, clist, clistlen) \

        SSL_ctrl(ctx,SSL_CTRL_SET_CURVES,clistlen,(char *)clist)

        SSL_set1_groups((ctx), (clist), (clistlen))

# define SSL_set1_curves_list(ctx, s) \

        SSL_ctrl(ctx,SSL_CTRL_SET_CURVES_LIST,0,(char *)s)

        SSL_set1_groups_list((ctx), (s))

# define SSL_get_shared_group(s, n) \

        SSL_ctrl(s,SSL_CTRL_GET_SHARED_GROUP,n,NULL)

# define SSL_get_shared_curve(s, n) \

        SSL_ctrl(s,SSL_CTRL_GET_SHARED_CURVE,n,NULL)

        SSL_get_shared_group((s), (n))

# define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \

        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SIGALGS,slistlen,(int *)slist)

# define SSL_CTX_set1_sigalgs_list(ctx, s) \