180 lines
8.6 KiB
HTML
180 lines
8.6 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html lang="en" dir="ltr">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
<title>documentation:2.0:webserviceprotection</title>
|
|||
|
|
<meta name="generator" content="DokuWiki"/>
|
|||
|
|
<meta name="robots" content="index,follow"/>
|
|||
|
|
<meta name="keywords" content="documentation,2.0,webserviceprotection"/>
|
|||
|
|
<link rel="search" type="application/opensearchdescription+xml" href="lib/exe/opensearch.html" title="LemonLDAP::NG"/>
|
|||
|
|
<link rel="start" href="webserviceprotection.html"/>
|
|||
|
|
<link rel="contents" href="webserviceprotection.html" title="Sitemap"/>
|
|||
|
|
<link rel="stylesheet" type="text/css" href="lib/exe/css.php.t.bootstrap3.css"/>
|
|||
|
|
<!-- //if:usedebianlibs
|
|||
|
|
<link rel="stylesheet" type="text/css" href="/javascript/bootstrap/css/bootstrap.min.css" />
|
|||
|
|
//elsif:useexternallibs
|
|||
|
|
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"></script>
|
|||
|
|
//elsif:cssminified
|
|||
|
|
<link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.min.css" />
|
|||
|
|
//else -->
|
|||
|
|
<link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.css" />
|
|||
|
|
<!-- //endif -->
|
|||
|
|
<script type="text/javascript">/*<![CDATA[*/var NS='documentation:2.0';var JSINFO = {"id":"documentation:2.0:webserviceprotection","namespace":"documentation:2.0"};
|
|||
|
|
/*!]]>*/</script>
|
|||
|
|
<script type="text/javascript" charset="utf-8" src="lib/exe/js.php.t.bootstrap3.js"></script>
|
|||
|
|
<!-- //if:usedebianlibs
|
|||
|
|
<script type="text/javascript" src="/javascript/jquery/jquery.min.js"></script>
|
|||
|
|
//elsif:useexternallibs
|
|||
|
|
<script type="text/javascript" src="http://code.jquery.com/jquery-2.2.0.min.js"></script>
|
|||
|
|
//elsif:jsminified
|
|||
|
|
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.min.js"></script>
|
|||
|
|
//else -->
|
|||
|
|
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.js"></script>
|
|||
|
|
<!-- //endif -->
|
|||
|
|
<!-- //if:usedebianlibs
|
|||
|
|
<script type="text/javascript" src="/javascript/jquery-ui/jquery-ui.min.js"></script>
|
|||
|
|
//elsif:useexternallibs
|
|||
|
|
<script type="text/javascript" src="http://code.jquery.com/ui/1.10.4/jquery-ui.min.js"></script>
|
|||
|
|
//elsif:jsminified
|
|||
|
|
<script type="text/javascript" src="/static/bwr/jquery-ui/jquery-ui.min.js"></script>
|
|||
|
|
//else -->
|
|||
|
|
<script type="text/javascript" src="/static/bwr/jquery-ui/jquery-ui.js"></script>
|
|||
|
|
<!-- //endif -->
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<div class="dokuwiki export container">
|
|||
|
|
<!-- TOC START -->
|
|||
|
|
<div id="dw__toc">
|
|||
|
|
<h3 class="toggle">Table of Contents</h3>
|
|||
|
|
<div>
|
|||
|
|
|
|||
|
|
<ul class="toc">
|
|||
|
|
<li class="level1"><div class="li"><a href="#presentation">Presentation</a></div></li>
|
|||
|
|
<li class="level1"><div class="li"><a href="#servicetoken_handler">ServiceToken Handler</a></div></li>
|
|||
|
|
<li class="level1"><div class="li"><a href="#oauth2_endpoints">OAuth2 endpoints</a></div>
|
|||
|
|
<ul class="toc">
|
|||
|
|
<li class="level2"><div class="li"><a href="#userinfo">UserInfo</a></div></li>
|
|||
|
|
<li class="level2"><div class="li"><a href="#introspection">Introspection</a></div></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1"><div class="li"><a href="#oauth2_handler">OAuth2 Handler</a></div></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<!-- TOC END -->
|
|||
|
|
|
|||
|
|
<h1 class="sectionedit1" id="webservicesapi">WebServices / API</h1>
|
|||
|
|
<div class="level1">
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<!-- EDIT1 SECTION "WebServices / API" [1-33] -->
|
|||
|
|
<h2 class="sectionedit2" id="presentation">Presentation</h2>
|
|||
|
|
<div class="level2">
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
WebServices and <abbr title="Application Programming Interface">API</abbr> are mostly requested by an application, and not the end-user itself. In this case, you can not rely on <abbr title="LemonLDAP::NG">LL::NG</abbr> standard Handler to protect the webservice, as it will expect a cookie, which is not defined in the application requesting the service.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
<abbr title="LemonLDAP::NG">LL::NG</abbr> offers several solutions to protect this kind of service.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<!-- EDIT2 SECTION "Presentation" [34-392] -->
|
|||
|
|
<h2 class="sectionedit3" id="servicetoken_handler">ServiceToken Handler</h2>
|
|||
|
|
<div class="level2">
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Two Handlers will be used:
|
|||
|
|
</p>
|
|||
|
|
<ul>
|
|||
|
|
<li class="level1"><div class="li"> The frontal Handler that will protect the web application, and will forge a specific token</div>
|
|||
|
|
</li>
|
|||
|
|
<li class="level1"><div class="li"> The backend Handler that will protect the web service, and will consume the token</div>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
See <a href="servertoserver.html" class="wikilink1" title="documentation:2.0:servertoserver">ServiceToken Handler documentation</a>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<!-- EDIT3 SECTION "ServiceToken Handler" [393-695] -->
|
|||
|
|
<h2 class="sectionedit4" id="oauth2_endpoints">OAuth2 endpoints</h2>
|
|||
|
|
<div class="level2">
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
We suppose here that <abbr title="LemonLDAP::NG">LL::NG</abbr> is acting as <a href="idpopenidconnect.html" class="wikilink1" title="documentation:2.0:idpopenidconnect">OpenID Connect provider</a>. The web application will then be able to get an access token from <abbr title="LemonLDAP::NG">LL::NG</abbr>. This token could be sent to the webservice that can then validate it against <abbr title="LemonLDAP::NG">LL::NG</abbr> OAuth2 endpoints.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<!-- EDIT4 SECTION "OAuth2 endpoints" [696-989] -->
|
|||
|
|
<h3 class="sectionedit5" id="userinfo">UserInfo</h3>
|
|||
|
|
<div class="level3">
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
You can use the UserInfo endpoint, which requires the access token to deliver user attributes.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
For example:
|
|||
|
|
</p>
|
|||
|
|
<pre class="code">curl \
|
|||
|
|
-H "Authorization: Bearer a74d504ec9e784785e70a1da2b95d1d2" \
|
|||
|
|
https://auth.example.ccom/oauth2/userinfo | json_pp</pre>
|
|||
|
|
<pre class="code file javascript"><span class="br0">{</span>
|
|||
|
|
<span class="st0">"family_name"</span> <span class="sy0">:</span> <span class="st0">"OUDOT"</span><span class="sy0">,</span>
|
|||
|
|
<span class="st0">"name"</span> <span class="sy0">:</span> <span class="st0">"Clément OUDOT"</span><span class="sy0">,</span>
|
|||
|
|
<span class="st0">"email"</span> <span class="sy0">:</span> <span class="st0">"clement@example.com"</span><span class="sy0">,</span>
|
|||
|
|
<span class="st0">"sub"</span> <span class="sy0">:</span> <span class="st0">"coudot"</span>
|
|||
|
|
<span class="br0">}</span></pre>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<!-- EDIT5 SECTION "UserInfo" [990-1412] -->
|
|||
|
|
<h3 class="sectionedit6" id="introspection">Introspection</h3>
|
|||
|
|
<div class="level3">
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Introspection endpoint is defined in <a href="https://tools.ietf.org/html/rfc7662" class="urlextern" title="https://tools.ietf.org/html/rfc7662" rel="nofollow">RFC 7662</a>. It requires an authentication (same as the authentication for the token endpoint) and takes to access token as parameter.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
For example:
|
|||
|
|
</p>
|
|||
|
|
<pre class="code">curl \
|
|||
|
|
-H "Authorization: Basic bGVtb25sZGFwOnNlY3JldA==" \
|
|||
|
|
-X POST -d "token=a74d504ec9e784785e70a1da2b95d1d2" \
|
|||
|
|
https://auth.example.com/oauth2/introspect | json_pp</pre>
|
|||
|
|
<pre class="code file javascript"><span class="br0">{</span>
|
|||
|
|
<span class="st0">"client_id"</span> <span class="sy0">:</span> <span class="st0">"lemonldap"</span><span class="sy0">,</span>
|
|||
|
|
<span class="st0">"sub"</span> <span class="sy0">:</span> <span class="st0">"coudot"</span><span class="sy0">,</span>
|
|||
|
|
<span class="st0">"exp"</span> <span class="sy0">:</span> <span class="nu0">1572446485</span><span class="sy0">,</span>
|
|||
|
|
<span class="st0">"active"</span> <span class="sy0">:</span> <span class="kw2">true</span><span class="sy0">,</span>
|
|||
|
|
<span class="st0">"scope"</span> <span class="sy0">:</span> <span class="st0">"openid profile address email phone"</span>
|
|||
|
|
<span class="br0">}</span></pre>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<!-- EDIT6 SECTION "Introspection" [1413-2024] -->
|
|||
|
|
<h2 class="sectionedit7" id="oauth2_handler">OAuth2 Handler</h2>
|
|||
|
|
<div class="level2">
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
We also suppose here that <abbr title="LemonLDAP::NG">LL::NG</abbr> is acting as <a href="idpopenidconnect.html" class="wikilink1" title="documentation:2.0:idpopenidconnect">OpenID Connect provider</a>. But the webservice will be protected by the OAuth2 Handler and will just have to read the HTTP headers to know which user is connected.
|
|||
|
|
</p>
|
|||
|
|
<pre class="code">curl \
|
|||
|
|
-H "Authorization: Bearer a74d504ec9e784785e70a1da2b95d1d2" \
|
|||
|
|
https://oauth2.example.ccom/rest/myapi </pre>
|
|||
|
|
<pre class="code file javascript"><span class="br0">{</span>
|
|||
|
|
<span class="st0">"check"</span> <span class="sy0">:</span> <span class="st0">"true"</span><span class="sy0">,</span>
|
|||
|
|
<span class="st0">"user"</span> <span class="sy0">:</span> <span class="st0">"coudot"</span>
|
|||
|
|
<span class="br0">}</span></pre>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
See <a href="oauth2handler.html" class="wikilink1" title="documentation:2.0:oauth2handler">OAuth2 Handler documentation</a>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<!-- EDIT7 SECTION "OAuth2 Handler" [2025-] --></div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|