<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#375EAB">
<title>jwt - The Go Programming Language</title>
<link type="text/css" rel="stylesheet" href="../../../../../lib/godoc/style.css">
<link rel="stylesheet" href="../../../../../lib/godoc/jquery.treeview.css">
<script type="text/javascript">window.initFuncs = [];</script>
</head>
<body>
<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
...
</div><!-- #lowframe -->
<div id="topbar" class="wide"><div class="container">
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">▽</span></a>
<form method="GET" action="http://localhost:6060/search">
<div id="menu">
<a href="http://localhost:6060/doc/">Documents</a>
<a href="http://localhost:6060/pkg/">Packages</a>
<a href="http://localhost:6060/project/">The Project</a>
<a href="http://localhost:6060/help/">Help</a>
<a href="http://localhost:6060/blog/">Blog</a>
<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
</div>
</form>
</div></div>
<div id="page" class="wide">
<div class="container">
<h1>Package jwt</h1>
<div id="nav"></div>
<!--
Copyright 2009 The Go Authors. All rights reserved.
Use of this source code is governed by a BSD-style
license that can be found in the LICENSE file.
-->
<!--
Note: Static (i.e., not template-generated) href and id
attributes start with "pkg-" to make it impossible for
them to conflict with generated attributes (some of which
correspond to Go identifiers).
-->
<script type='text/javascript'>
document.ANALYSIS_DATA = null;
document.CALLGRAPH = null;
</script>
<div id="short-nav">
<dl>
<dd><code>import "golang.org/x/oauth2/jwt"</code></dd>
</dl>
<dl>
<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
</dl>
</div>
<!-- The package's Name is printed as title by the top-level template -->
<div id="pkg-overview" class="toggleVisible">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
</div>
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
<p>
Package jwt implements the OAuth 2.0 JSON Web Token flow, commonly
known as "two-legged OAuth 2.0".
</p>
<p>
See: <a href="https://tools.ietf.org/html/draft-ietf-oauth-jwt-bearer-12">https://tools.ietf.org/html/draft-ietf-oauth-jwt-bearer-12</a>
</p>
</div>
</div>
<div id="pkg-index" class="toggleVisible">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
</div>
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
<div id="manual-nav">
<dl>
<dd><a href="index.html#Config">type Config</a></dd>
<dd> <a href="index.html#Config.Client">func (c *Config) Client(ctx context.Context) *http.Client</a></dd>
<dd> <a href="index.html#Config.TokenSource">func (c *Config) TokenSource(ctx context.Context) oauth2.TokenSource</a></dd>
</dl>
</div><!-- #manual-nav -->
<h4>Package files</h4>
<p>
<span style="font-size:90%">
<a href="http://localhost:6060/src/golang.org/x/oauth2/jwt/jwt.go">jwt.go</a>
</span>
</p>
</div><!-- .expanded -->
</div><!-- #pkg-index -->
<div id="pkg-callgraph" class="toggle" style="display: none">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
</div> <!-- .expanded -->
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
<p>
In the call graph viewer below, each node
is a function belonging to this package
and its children are the functions it
calls—perhaps dynamically.
</p>
<p>
The root nodes are the entry points of the
package: functions that may be called from
outside the package.
There may be non-exported or anonymous
functions among them if they are called
dynamically from another package.
</p>
<p>
Click a node to visit that function's source code.
From there you can visit its callers by
clicking its declaring <code>func</code>
token.
</p>
<p>
Functions may be omitted if they were
determined to be unreachable in the
particular programs or tests that were
analyzed.
</p>
<!-- Zero means show all package entry points. -->
<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
</div>
</div> <!-- #pkg-callgraph -->
<h2 id="Config">type <a href="http://localhost:6060/src/golang.org/x/oauth2/jwt/jwt.go?s=803:1774#L24">Config</a></h2>
<pre>type Config struct {
<span class="comment">// Email is the OAuth client identifier used when communicating with</span>
<span class="comment">// the configured OAuth provider.</span>
Email <a href="../../../../builtin/index.html#string">string</a>
<span class="comment">// PrivateKey contains the contents of an RSA private key or the</span>
<span class="comment">// contents of a PEM file that contains a private key. The provided</span>
<span class="comment">// private key is used to sign JWT payloads.</span>
<span class="comment">// PEM containers with a passphrase are not supported.</span>
<span class="comment">// Use the following command to convert a PKCS 12 file into a PEM.</span>
<span class="comment">//</span>
<span class="comment">// $ openssl pkcs12 -in key.p12 -out key.pem -nodes</span>
<span class="comment">//</span>
PrivateKey []<a href="../../../../builtin/index.html#byte">byte</a>
<span class="comment">// PrivateKeyID contains an optional hint indicating which key is being</span>
<span class="comment">// used.</span>
PrivateKeyID <a href="../../../../builtin/index.html#string">string</a>
<span class="comment">// Subject is the optional user to impersonate.</span>
Subject <a href="../../../../builtin/index.html#string">string</a>
<span class="comment">// Scopes optionally specifies a list of requested permission scopes.</span>
Scopes []<a href="../../../../builtin/index.html#string">string</a>
<span class="comment">// TokenURL is the endpoint required to complete the 2-legged JWT flow.</span>
TokenURL <a href="../../../../builtin/index.html#string">string</a>
<span class="comment">// Expires optionally specifies how long the token is valid for.</span>
Expires <a href="../../../../time/index.html">time</a>.<a href="../../../../time/index.html#Duration">Duration</a>
}</pre>
<p>
Config is the configuration for using JWT to fetch tokens,
commonly known as "two-legged OAuth 2.0".
</p>
<h3 id="Config.Client">func (*Config) <a href="http://localhost:6060/src/golang.org/x/oauth2/jwt/jwt.go?s=2233:2290#L67">Client</a></h3>
<pre>func (c *<a href="index.html#Config">Config</a>) Client(ctx <a href="../../net/context/index.html">context</a>.<a href="../../net/context/index.html#Context">Context</a>) *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Client">Client</a></pre>
<p>
Client returns an HTTP client wrapping the context's
HTTP transport and adding Authorization headers with tokens
obtained from c.
</p>
<p>
The returned client and its Transport should not be modified.
</p>
<h3 id="Config.TokenSource">func (*Config) <a href="http://localhost:6060/src/golang.org/x/oauth2/jwt/jwt.go?s=1896:1964#L58">TokenSource</a></h3>
<pre>func (c *<a href="index.html#Config">Config</a>) TokenSource(ctx <a href="../../net/context/index.html">context</a>.<a href="../../net/context/index.html#Context">Context</a>) <a href="../index.html">oauth2</a>.<a href="../index.html#TokenSource">TokenSource</a></pre>
<p>
TokenSource returns a JWT TokenSource using the configuration
in c and the HTTP client from the provided context.
</p>
<div id="footer">
Build version go1.6.<br>
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
the content of this page is licensed under the
Creative Commons Attribution 3.0 License,
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
</div>
</div><!-- .container -->
</div><!-- #page -->
<!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
<script type="text/javascript" src="../../../../../lib/godoc/jquery.js"></script>
<script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.js"></script>
<script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.edit.js"></script>
<script type="text/javascript" src="../../../../../lib/godoc/godocs.js"></script>
</body>
</html>