JWT-GENERATE(1) LibJWT C Library JWT-GENERATE(1) NAME jwt-generate - Generate a JSON Web Token SYNOPSIS jwt-generate [options] DESCRIPTION jwt-generate Generates and (optionally) signs a JSON Web Token. By default this will simply encode a JWT. If you want a signature, then you must give a JWK key with the -k option. Generating a signature re- quires specifying the algorithm, so it must either be in the key file (as the alg attribute), or passed on the command line with the -a argument. If -a is specified and the key has an alg attribute, they must match. One token will be generated for each call. You can specify claims using the -c option. By default, jwt-generate will add the iat claim, which is Issued At and is the time in seconds since the Unix Epcoch. When using the --verbose option, jwt-generate will print the JSON HEADER and PAYLOAD to stdout. If used in conjunction with --print, the JSON will be piped to the com- mand's stdin. It will be called twice: once for HEAD and once for PAYLOAD. One use is to pass it through jq -C for indenting and colorization. An- other would be to use an external program to inspect the PAYLOAD contents. A non-0 exit status from the program will cause generating the token to fail. Options -h, --help Show common options and quit. -l, --list List all supported algorithms that can be passed to the -a option and quit. -v, --verbose Show the contents of the HEADER and PAYLOAD of the JWT in addition to generating the token. NOTE the header will not show the typ or alg attributes since they do not get added until the final step. -q, --quiet Do not output anything except for hard errors. On success you will only see the token generared. -n, --no-iat Do not add the iat (Issued-At) time to the token. Useful for a slightly smaller token, and for reproducible output. -a ALG, --algorithm=ALG Specify the algorithm to be used when signing the token. -k FILE, --key=FILE Path to a file containing a key in JSON Web Key format. If your keys are in PEM or DER (or some other common format that OpenSSL un- derstands), then you can convert it to a JWK with the key2jwk(1) tool. May be given more than once: the first key is the primary signer and each additional -k adds a signature, producing a multi-signature JWS JSON Serialization (RFC 7515 A<section>7.2). Each additional key's algorithm comes from its own alg. -F FORMAT, --format=FORMAT Serialization to emit: compact (the default, a single header.pay- load.signature string), flat (the JSON Flattened form), or general (the JSON General form with a signatures array). Supplying more than one -k implies general. -c CLAIM, --claim=CLAIM Add a claim to the JWT. The format of CLAIM is t:key=value Where t is the type and is one of i for integer, s for string, or b for boolean. The value for integer must be parseable by strtol(3). For boolean, any value starting with 0, f, or F will be interpreted as false. Anything else will be considered true. They key is any ASCII string. -j JSON, --json=JSON Use JSON string as the payload of the token. This will not replace, but be added to the payload. The string must be in valid JSON, meaning either a {} object or a [] array. BUGS See GitHub Issues: https://github.com/benmcollins/libjwt/issues AUTHOR jwt-generate was originally written by Jeremy Thien. Major rewriting and man page by Ben Collins bcollins@libjwt.io. SEE ALSO jwt-verify(1), key2jwk(1), jwk2key(1) jwt-generate User Manual JWT-GENERATE(1)
NAME | SYNOPSIS | DESCRIPTION | BUGS | AUTHOR | SEE ALSO
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=jwt-generate&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>