https://github.com/emcrisostomo/jwt-cli

A shell library to decode JWT tokens
https://github.com/emcrisostomo/jwt-cli

json-web-token jwt jwt-token shell zsh

Last synced: 3 months ago
JSON representation

A shell library to decode JWT tokens

• Host: GitHub
• URL: https://github.com/emcrisostomo/jwt-cli
• Owner: emcrisostomo
• License: gpl-3.0
• Created: 2018-04-09T09:19:31.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-07T23:27:38.000Z (almost 5 years ago)
• Last Synced: 2024-10-25T08:09:16.301Z (3 months ago)
• Topics: json-web-token, jwt, jwt-token, shell, zsh
• Language: Shell
• Homepage:
• Size: 36.1 KB
• Stars: 42
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README
  • Changelog: ChangeLog
  • Contributing: CONTRIBUTING
  • License: COPYING
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg?style=flat)](https://github.com/emcrisostomo/jwt-cli/blob/master/LICENSE)

jwt-cli

=======

`jwt-cli` is a shell library to decode JWT tokens.

Prerequisites

-------------

`jwt-cli` requires the following programs to be present on the `${PATH}`:

  * `jq`: optional.  If present, pretty output will be emitted.

  * `base64` or `openssl`

  * `zsh`

Getting jwt-cli

---------------

A user who whishes to build this package should get a [release

tarball][release].  A release tarball contains everything a user needs to build

the package on his system, following the instructions detailed in the

Installation section below and the `INSTALL` file.

A developer who wishes to modify this package should get the sources (either

from a source tarball or cloning the repository) and have the GNU Build System

installed on his machine.  Please read `README.gnu-build-system` to get further

details about how to bootstrap this package from sources on your machine.

Getting a copy of the source repository is not recommended unless you are a

developer, you have the GNU Build System installed on your machine, and you know

how to bootstrap it on the sources.

[release]: https://github.com/emcrisostomo/jwt-cli/releases

Installation

------------

See the `INSTALL` file for detailed information about how to configure and

install this package.

Usage

-----

The following operation decodes a JWT token:

    $ jwt-decode token

    {

      "alg": "RS256",

      "typ": "JWT",

      "kid": "sbS_BWBm0GzfIQRnYWolcWDRnjqwDTY_Aq6Fn_boqKM"

    }

    {

      "jti": "271151a3-db11-4f37-a724-4cf9957774f4",

      "exp": 1530979706,

      "nbf": 0,

      "iat": 1523117306,

      "iss": "https://domain.com/auth/realms/realm",

      "aud": "app-name",

      "sub": "5132c417-d772-420e-b5db-401ea633dca1",

      "typ": "Bearer",

      "azp": "app",

      "auth_time": 0,

      "session_state": "84e6a759-e54d-4fd7-9fcf-bb51131aab89",

      "acr": "1",

      "allowed-origins": [

        ""

      ],

      "realm_access": {

        "roles": [

          "role0",

          "role1",

          "role2"

        ]

      },

      "resource_access": {

        "account": {

          "roles": [

            "manage-account",

            "manage-account-links",

            "view-profile"

          ]

        }

      },

      "custom-property": "1797"

    }

Bug Reports

-----------

Bug reports can be sent directly to the authors.

-----

Copyright (c) 2018 Enrico M. Crisostomo

This program is free software; you can redistribute it and/or modify it under

the terms of the GNU General Public License as published by the Free Software

Foundation; either version 3, or (at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with

this program.  If not, see .