2023-02-19 19:12:12 +03:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta name = "description" content = "Getting started with golang-jwt/jwt" >
< link rel = "canonical" href = "https://golang-jwt.github.io/jwt/" >
2023-03-25 17:37:00 +03:00
< link rel = "next" href = "usage/create/" >
2023-02-19 19:12:12 +03:00
< link rel = "icon" href = "assets/jwt.png" >
2023-05-23 09:38:56 +03:00
< meta name = "generator" content = "mkdocs-1.4.3, mkdocs-material-9.1.14" >
2023-02-19 19:12:12 +03:00
< title > golang-jwt docs< / title >
2023-05-23 09:38:56 +03:00
< link rel = "stylesheet" href = "assets/stylesheets/main.85bb2934.min.css" >
2023-02-19 19:12:12 +03:00
2023-05-23 09:38:56 +03:00
< link rel = "stylesheet" href = "assets/stylesheets/palette.a6bdf11c.min.css" >
2023-02-19 19:12:12 +03:00
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< script > _ _md _scope = new URL ( "." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
2023-03-25 17:37:00 +03:00
< meta property = "og:type" content = "website" >
< meta property = "og:title" content = "Getting Started" >
< meta property = "og:description" content = "Getting started with golang-jwt/jwt" >
< meta property = "og:image" content = "https://golang-jwt.github.io/jwt/assets/images/social/index.png" >
< meta property = "og:image:type" content = "image/png" >
< meta property = "og:image:width" content = "1200" >
< meta property = "og:image:height" content = "630" >
< meta property = "og:url" content = "https://golang-jwt.github.io/jwt/" >
< meta name = "twitter:card" content = "summary_large_image" >
< meta name = "twitter:title" content = "Getting Started" >
< meta name = "twitter:description" content = "Getting started with golang-jwt/jwt" >
< meta name = "twitter:image" content = "https://golang-jwt.github.io/jwt/assets/images/social/index.png" >
2023-02-19 19:12:12 +03:00
< / head >
2023-03-25 17:37:00 +03:00
< body dir = "ltr" data-md-color-scheme = "default" data-md-color-primary = "light-blue" data-md-color-accent = "purple" >
2023-02-19 19:12:12 +03:00
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#getting-started" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "." title = "golang-jwt docs" class = "md-header__button md-logo" aria-label = "golang-jwt docs" data-md-component = "logo" >
< img src = "assets/jwt.png" alt = "logo" >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
golang-jwt docs
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
2023-03-25 17:37:00 +03:00
Getting Started
2023-02-19 19:12:12 +03:00
< / span >
< / div >
< / div >
< / div >
2023-05-23 09:38:56 +03:00
2023-02-19 19:12:12 +03:00
2023-03-26 23:12:56 +03:00
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" / > < / svg >
< / button >
< / nav >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" role = "presentation" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
2023-02-19 19:12:12 +03:00
< div class = "md-header__source" >
< a href = "https://github.com/golang-jwt/jwt" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2023-04-12 17:21:17 +03:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
2023-02-19 19:12:12 +03:00
< / div >
< div class = "md-source__repository" >
golang-jwt/jwt
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
2023-03-25 17:37:00 +03:00
< nav class = "md-tabs" aria-label = "Tabs" data-md-component = "tabs" >
< div class = "md-grid" >
< ul class = "md-tabs__list" >
< li class = "md-tabs__item" >
< a href = "." class = "md-tabs__link md-tabs__link--active" >
Getting Started
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "usage/create/" class = "md-tabs__link" >
Usage
< / a >
< / li >
< / ul >
< / div >
< / nav >
2023-02-19 19:12:12 +03:00
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
2023-03-25 17:37:00 +03:00
2023-02-19 19:12:12 +03:00
2023-03-25 17:37:00 +03:00
< nav class = "md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label = "Navigation" data-md-level = "0" >
2023-02-19 19:12:12 +03:00
< label class = "md-nav__title" for = "__drawer" >
< a href = "." title = "golang-jwt docs" class = "md-nav__button md-logo" aria-label = "golang-jwt docs" data-md-component = "logo" >
< img src = "assets/jwt.png" alt = "logo" >
< / a >
golang-jwt docs
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/golang-jwt/jwt" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2023-04-12 17:21:17 +03:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
2023-02-19 19:12:12 +03:00
< / div >
< div class = "md-source__repository" >
golang-jwt/jwt
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
2023-03-25 17:37:00 +03:00
Getting Started
2023-02-19 19:12:12 +03:00
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "." class = "md-nav__link md-nav__link--active" >
2023-03-25 17:37:00 +03:00
Getting Started
2023-02-19 19:12:12 +03:00
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
2023-03-25 17:37:00 +03:00
< a href = "#supported-go-versions" class = "md-nav__link" >
Supported Go versions
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#what-the-heck-is-a-jwt" class = "md-nav__link" >
What the heck is a JWT?
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#whats-in-the-box" class = "md-nav__link" >
What's in the box?
2023-02-19 19:12:12 +03:00
< / a >
< / li >
< li class = "md-nav__item" >
2023-03-25 17:37:00 +03:00
< a href = "#installation-guidelines" class = "md-nav__link" >
Installation Guidelines
2023-02-19 19:12:12 +03:00
< / a >
2023-03-30 23:34:41 +03:00
< / li >
< li class = "md-nav__item" >
< a href = "#jwt-and-oauth-20" class = "md-nav__link" >
JWT and OAuth 2.0
< / a >
2023-02-19 19:12:12 +03:00
< / li >
< / ul >
< / nav >
< / li >
2023-03-25 17:37:00 +03:00
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2" >
< label class = "md-nav__link" for = "__nav_2" id = "__nav_2_label" tabindex = "0" >
Usage
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2" >
< span class = "md-nav__icon md-icon" > < / span >
Usage
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "usage/create/" class = "md-nav__link" >
Creating a New JWT
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "usage/parse/" class = "md-nav__link" >
Parsing and Validating a JWT
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "usage/signing_methods/" class = "md-nav__link" >
2023-03-30 22:58:15 +03:00
Signing Methods
2023-03-25 17:37:00 +03:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
2023-02-19 19:12:12 +03:00
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
2023-03-25 17:37:00 +03:00
< h1 id = "getting-started" > Getting Started< / h1 >
< p > Welcome to < code > jwt-go< / code > , a < a href = "http://www.golang.org" > go< / a > (or 'golang' for search engine friendliness) implementation of < a href = "https://datatracker.ietf.org/doc/html/rfc7519" > JSON Web Tokens< / a > . < / p >
< h3 id = "supported-go-versions" > Supported Go versions< / h3 >
< p > Our support of Go versions is aligned with Go's < a href = "https://golang.org/doc/devel/release#policy" > version release
policy< / a > . So we will support a major
version of Go until there are two newer major releases. We no longer support
building jwt-go with unsupported Go versions, as these contain security
vulnerabilities which will not be fixed.< / p >
< h2 id = "what-the-heck-is-a-jwt" > What the heck is a JWT?< / h2 >
< p > JWT.io has < a href = "https://jwt.io/introduction" > a great introduction< / a > to JSON Web Tokens.< / p >
< p > In short, it's a signed JSON object that does something useful (for example, authentication). It's commonly used for < code > Bearer< / code > tokens in OAuth 2.0 A token is made of three parts, separated by < code > .< / code > 's. The first two parts are JSON objects, that have been < a href = "https://datatracker.ietf.org/doc/html/rfc4648" > base64url< / a > encoded. The last part is the signature, encoded the same way.< / p >
< p > The first part is called the header. It contains the necessary information for verifying the last part, the signature. For example, which encryption method was used for signing and what key was used.< / p >
< p > The part in the middle is the interesting bit. It's called the Claims and contains the actual stuff you care about. Refer to < a href = "https://datatracker.ietf.org/doc/html/rfc7519" > RFC 7519< / a > for information about reserved keys and the proper way to add your own.< / p >
< h2 id = "whats-in-the-box" > What's in the box?< / h2 >
< p > This library supports the parsing and verification as well as the generation and signing of JWTs. Current supported signing algorithms are HMAC SHA, RSA, RSA-PSS, ECDSA and EdDSA, though hooks are present for adding your own.< / p >
< h2 id = "installation-guidelines" > Installation Guidelines< / h2 >
< p > To install the jwt package, you first need to have < a href = "https://go.dev/doc/install" > Go< / a > installed, then you can use the command below to add < code > jwt-go< / code > as a dependency in your Go program.< / p >
< div class = "language-sh highlight" > < pre > < span > < / span > < code > < span id = "__span-0-1" > < a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" > < / a > go< span class = "w" > < / span > get< span class = "w" > < / span > -u< span class = "w" > < / span > github.com/golang-jwt/jwt/v5
< / span > < / code > < / pre > < / div >
< p > Then import it in your code:< / p >
< div class = "language-go highlight" > < pre > < span > < / span > < code > < span id = "__span-1-1" > < a id = "__codelineno-1-1" name = "__codelineno-1-1" href = "#__codelineno-1-1" > < / a > < span class = "kn" > import< / span > < span class = "w" > < / span > < span class = "s" > " github.com/golang-jwt/jwt/v5" < / span >
< / span > < / code > < / pre > < / div >
2023-03-30 23:34:41 +03:00
< h2 id = "jwt-and-oauth-20" > JWT and OAuth 2.0< / h2 >
< p > It's worth mentioning that OAuth and JWT are not the same thing. A JWT token is simply a signed JSON object. It can be used anywhere such a thing is useful. There is some confusion, though, as JWT is the most common type of bearer token used in OAuth2 authentication.< / p >
< p > Without going too far down the rabbit hole, here's a description of the interaction of these technologies:< / p >
< ul >
< li > OAuth is a protocol for allowing an identity provider to be separate from the service a user is logging in to. For example, whenever you use Facebook to log into a different service (Yelp, Spotify, etc), you are using OAuth.< / li >
< li > OAuth defines several options for passing around authentication data. One popular method is called a "bearer token". A bearer token is simply a string that should only be held by an authenticated user. Thus, simply presenting this token proves your identity. You can probably derive from here why a JWT might make a good bearer token. This is also specified in the JSON Web Token (JWT) Profile for OAuth 2.0 Access Tokens, detailed in < a href = "https://datatracker.ietf.org/doc/html/rfc9068" > RFC 9068< / a > .< / li >
< li > Because bearer tokens are used for authentication, it's important they're kept secret. This is why transactions that use bearer tokens typically happen over TLS.< / li >
< / ul >
2023-02-19 19:12:12 +03:00
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
2023-03-25 17:37:00 +03:00
< script id = "__config" type = "application/json" > { "base" : "." , "features" : [ "navigation.instant" , "navigation.tabs" , "toc.integrate" , "content.code.copy" , "content.code.annotate" ] , "search" : "assets/javascripts/workers/search.208ed371.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } } < / script >
2023-02-19 19:12:12 +03:00
2023-05-23 09:38:56 +03:00
< script src = "assets/javascripts/bundle.b4d07000.min.js" > < / script >
2023-02-19 19:12:12 +03:00
< / body >
< / html >
