lws-jws.h

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010-2018 Andy Green <andy@warmcat.com>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation:
 *  version 2.1 of the License.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 *  MA  02110-1301  USA
 *
 * included from libwebsockets.h
 */
 
 
/*
 * The maps are built to work with both JWS (LJWS_) and JWE (LJWE_), and are
 * sized to the slightly larger JWE case.
 */
 
enum enum_jws_sig_elements {
 
        /* JWS block namespace */
        LJWS_JOSE,
        LJWS_PYLD,
        LJWS_SIG,
        LJWS_UHDR,
 
        /* JWE block namespace */
        LJWE_JOSE = 0,
        LJWE_EKEY,
        LJWE_IV,
        LJWE_CTXT,
        LJWE_ATAG,
        LJWE_AAD,
 
        LWS_JWS_MAX_COMPACT_BLOCKS
};
 
struct lws_jws_map {
        const char *buf[LWS_JWS_MAX_COMPACT_BLOCKS];
        uint32_t len[LWS_JWS_MAX_COMPACT_BLOCKS];
};
 
#define LWS_JWS_MAX_SIGS 3
 
struct lws_jws {
        struct lws_jwk *jwk; /* the struct lws_jwk containing the signing key */
        struct lws_context *context; /* the lws context (used to get random) */
        struct lws_jws_map map, map_b64;
};
 
/* jws EC signatures do not have ASN.1 in them, meaning they're incompatible
 * with generic signatures.
 */
 
LWS_VISIBLE LWS_EXTERN void
lws_jws_init(struct lws_jws *jws, struct lws_jwk *jwk,
             struct lws_context *context);
 
LWS_VISIBLE LWS_EXTERN void
lws_jws_destroy(struct lws_jws *jws);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_sig_confirm_compact(struct lws_jws_map *map, struct lws_jwk *jwk,
                            struct lws_context *context,
                            char *temp, int *temp_len);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_sig_confirm_compact_b64_map(struct lws_jws_map *map_b64,
                                    struct lws_jwk *jwk,
                                    struct lws_context *context,
                                    char *temp, int *temp_len);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_sig_confirm_compact_b64(const char *in, size_t len,
                                struct lws_jws_map *map,
                                struct lws_jwk *jwk,
                                struct lws_context *context,
                                char *temp, int *temp_len);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_sig_confirm(struct lws_jws_map *map_b64, /* b64-encoded */
                    struct lws_jws_map *map,    /* non-b64 */
                    struct lws_jwk *jwk, struct lws_context *context);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_sign_from_b64(struct lws_jose *jose, struct lws_jws *jws, char *b64_sig,
                        size_t sig_len);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_compact_decode(const char *in, int len, struct lws_jws_map *map,
                struct lws_jws_map *map_b64, char *out, int *out_len);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_compact_encode(struct lws_jws_map *map_b64, /* b64-encoded */
                       const struct lws_jws_map *map,   /* non-b64 */
                       char *buf, int *out_len);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_sig_confirm_json(const char *in, size_t len,
                         struct lws_jws *jws, struct lws_jwk *jwk,
                         struct lws_context *context,
                         char *temp, int *temp_len);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_write_flattened_json(struct lws_jws *jws, char *flattened, size_t len);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_write_compact(struct lws_jws *jws, char *compact, size_t len);
 
 
 
/*
 * below apis are not normally needed if dealing with whole JWS... they're
 * useful for creating from scratch
 */
 
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_dup_element(struct lws_jws_map *map, int idx,
                    char *temp, int *temp_len, const void *in, size_t in_len,
                    size_t actual_alloc);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_randomize_element(struct lws_context *context,
                          struct lws_jws_map *map,
                          int idx, char *temp, int *temp_len, size_t random_len,
                          size_t actual_alloc);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_alloc_element(struct lws_jws_map *map, int idx, char *temp,
                      int *temp_len, size_t len, size_t actual_alloc);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_encode_b64_element(struct lws_jws_map *map, int idx,
                           char *temp, int *temp_len, const void *in,
                           size_t in_len);
 
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_b64_compact_map(const char *in, int len, struct lws_jws_map *map);
 
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_base64_enc(const char *in, size_t in_len, char *out, size_t out_max);
 
LWS_VISIBLE LWS_EXTERN int
lws_jws_encode_section(const char *in, size_t in_len, int first, char **p,
                       char *end);