https://api.github.com/repos/cngarrison/Mojolicious-Plugin-Kinde/contents/{+path}

btn_perl_bg.gif

Plugin to handle auth in Mojolicious for Kinde auth service

Other

Mojolicious-Plugin-Kinde

<div id="readme" class="md" data-path="README.md"><article class="markdown-body entry-content container-lg"><h1 id="user-content-name" dir="auto">NAME</h1>
<p dir="auto">Mojolicious::Plugin::Kinde - A Mojo helper and route condition to extract Kinde auth header, verify JWT token, and return the claims</p>
<h1 id="user-content-version" dir="auto">VERSION</h1>
<p dir="auto">version v0.0.1</p>
<h1 id="user-content-synopsis" dir="auto">SYNOPSIS</h1>
<div class="snippet-clipboard-content notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="package MyApp;
use Mojo::Base 'Mojolicious';

sub startup {
        my $self = shift;

        $self->plugin( 'Mojolicious::Plugin::Kinde' ); # config can also be supplied here

        $self->routes->get('/api')->requires( kinde_auth => {} );

}

...

# myapp_mojo.pl (config)

{
        kinde => {
                jwks_url => 'https://your-domain.kinde.com/.well-known/jwks.json',
                iss      => 'https://your-domain.kinde.com',
        },
}

...

my $claims = $c->get_kinde_claims"><pre class="notranslate"><code>package MyApp;
use Mojo::Base 'Mojolicious';

sub startup {
        my $self = shift;

        $self-&gt;plugin( 'Mojolicious::Plugin::Kinde' ); # config can also be supplied here

        $self-&gt;routes-&gt;get('/api')-&gt;requires( kinde_auth =&gt; {} );

}

...

# myapp_mojo.pl (config)

{
        kinde =&gt; {
                jwks_url =&gt; 'https://your-domain.kinde.com/.well-known/jwks.json',
                iss      =&gt; 'https://your-domain.kinde.com',
        },
}

...

my $claims = $c-&gt;get_kinde_claims
</code></pre></div>
<h1 id="user-content-description" dir="auto">DESCRIPTION</h1>
<p dir="auto">Mojolicious::Plugin::Kinde creates a helper method and a route condition. Both retrieve the JWT
token from the <code>Authorization</code> header, verify the JWT, and do some sanity checks on the claims.
The <code>get_kinde_claims</code> helper will return the claims extracted from the token.</p>
<p dir="auto">The sanity checks include:</p>
<ul dir="auto">
<li>confirm <code>iss</code> claim matches the value from <code>kinde</code> config</li>
<li>confirm the <code>alg</code> is <code>RS256</code></li>
<li>confirm the <code>aud</code> array contains the value from <code>kinde</code> config (if not empty)</li>
</ul>
<h1 id="user-content-helpers" dir="auto">HELPERS</h1>
<h2 id="user-content-get_kinde_claims" dir="auto">get_kinde_claims()</h2>
<p dir="auto">Verifies the JWT from <code>Authorization</code> header and returns the extracted claims.</p>
<h1 id="user-content-route-conditions" dir="auto">ROUTE CONDITIONS</h1>
<h2 id="user-content-kinde_auth" dir="auto">kinde_auth</h2>
<p dir="auto">Verifies the JWT from <code>Authorization</code> header and returns boolean for the route condition.</p>
<h1 id="user-content-methods" dir="auto">METHODS</h1>
<p dir="auto">Mojolicious::Plugin::Kinde inherits all methods from Mojolicious::Plugin and implements the following new ones.</p>
<h2 id="user-content-register" dir="auto">register</h2>
<div class="snippet-clipboard-content notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="$plugin->register(Mojolicious->new);"><pre class="notranslate"><code>$plugin-&gt;register(Mojolicious-&gt;new);
</code></pre></div>
<p dir="auto">Register conditions in Mojolicious application.</p>
<h1 id="user-content-see-also" dir="auto">SEE ALSO</h1>
<ul dir="auto">
<li><a href="https://metacpan.org/pod/Mojo%3A%3AJWT" rel="nofollow">Mojo::JWT</a></li>
<li><a href="https://kinde.com/" rel="nofollow">Kinde</a> fantastic auth service</li>
</ul>
<h1 id="user-content-support" dir="auto">SUPPORT</h1>
<h2 id="user-content-bugs--feature-requests" dir="auto">Bugs / Feature Requests</h2>
<p dir="auto">Please report any bugs or feature requests through the issue tracker at
<a href="https://github.com/cngarrison/Mojolicious-Plugin-Kinde/issues">https://github.com/cngarrison/Mojolicious-Plugin-Kinde/issues</a>. You will
be notified automatically of any progress on your issue.</p>
<h2 id="user-content-source-code" dir="auto">Source Code</h2>
<p dir="auto">This is open source software. The code repository is available for
public review and contribution under the terms of the license.</p>
<p dir="auto"><a href="https://github.com/cngarrison/Mojolicious-Plugin-Kinde">https://github.com/cngarrison/Mojolicious-Plugin-Kinde</a></p>
<div class="snippet-clipboard-content notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="git clone git://github.com/cngarrison/Mojolicious-Plugin-Kinde.git"><pre class="notranslate"><code>git clone git://github.com/cngarrison/Mojolicious-Plugin-Kinde.git
</code></pre></div>
<h1 id="user-content-author" dir="auto">AUTHOR</h1>
<p dir="auto">Charlie Garrison <a href="mailto:cng@cngarrison.com">cng@cngarrison.com</a></p>
<h1 id="user-content-copyright-and-license" dir="auto">COPYRIGHT AND LICENSE</h1>
<p dir="auto">This software is copyright (c) 2023 by Charlie Garrison.</p>
<p dir="auto">This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.</p>
</article></div>