diogo
/
indieauth
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added to README, php version constraint, doc regen

This commit is contained in:
Barnaby Walters 2021-06-24 13:43:00 +02:00
parent c5ab491fc8
commit 85afbd7ff1
10 changed files with 154 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -5,9 +5,26 @@
A PSR-7-compatible implementation of the request-handling logic for IndieAuth authorization endpoints
and token endpoints.
* [API Documentation](https://taproot.github.io/indieauth/)
* [API Documentation](https://taproot.github.io/indieauth/namespaces/taproot-indieauth.html)
* [Code Coverage](https://taproot.github.io/indieauth/coverage/)
## Installation
taproot/indieauth is currently tested against and compatible with PHP 7.3, 7.4, and 8.0.
Install taproot/indieauth using [composer](https://getcomposer.org/):
composer.phar require taproot/indieauth
composer.phar install (or composer.phar update)
Versioned releases are GPG signed so you can verify that the code hasn’t been tampered with.
gpg --recv-keys 1C00430B19C6B426922FE534BEF8CE58118AD524
cd vendor/taproot/indieauth
git tag -v v0.1.0 # Replace with the version you have installed
## Usage
Typical minimal usage looks something like this:
```php
@ -59,3 +76,11 @@ documentation](https://taproot.github.io/indieauth/namespaces/taproot-indieauth.
* [Taproot\IndieAuth\Callback\SingleUserPasswordAuthenticationCallback](https://taproot.github.io/indieauth/classes/Taproot-IndieAuth-Callback-SingleUserPasswordAuthenticationCallback.html) for an example of how to implement an authentication callback, and it’s [corresponding template](https://github.com/Taproot/indieauth/blob/main/templates/single_user_password_authentication_form.html.php) for information on customising the template.
* [Taproot\IndieAuth\Storage\TokenStorageInterface](https://taproot.github.io/indieauth/classes/Taproot-IndieAuth-Storage-TokenStorageInterface.html) for details about implementing your own token storage
* [Taproot\IndieAuth\Callback\AuthorizationFormInterface](https://taproot.github.io/indieauth/classes/Taproot-IndieAuth-Callback-AuthorizationFormInterface.html) for infomation about implementing your own authorization form.
### Example Application
See the [taproot/micropub example app](https://github.com/Taproot/micropub-adapter/tree/main/example) for a working example of how to use taproot/indieauth.
## Changelog
* v0.1.0 coming soon!

3
composer.json
View File

@ -30,7 +30,8 @@
"mf2/mf2": "^0.4.6",
"barnabywalters/mf-cleaner": "^0.1.4",
"guzzlehttp/psr7": "^1.8",
"webmozart/path-util": "^2.3"
"webmozart/path-util": "^2.3",
"php": ">= 7.3.0"
},
"require-dev": {
"guzzlehttp/guzzle": "^7.3",

23
docs/classes/Taproot-IndieAuth-Callback-DefaultAuthorizationForm.html
View File

@ -215,7 +215,7 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/DefaultAuthorizationForm.php"><a href="files/src-callback-defaultauthorizationform.html"><abbr title="src/Callback/DefaultAuthorizationForm.php">DefaultAuthorizationForm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
@ -225,7 +225,8 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<span class="phpdocumentor-signature__name">$csrfKey</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -245,7 +246,7 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/DefaultAuthorizationForm.php"><a href="files/src-callback-defaultauthorizationform.html"><abbr title="src/Callback/DefaultAuthorizationForm.php">DefaultAuthorizationForm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
@ -255,7 +256,8 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<span class="phpdocumentor-signature__name">$formTemplatePath</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -275,7 +277,7 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/DefaultAuthorizationForm.php"><a href="files/src-callback-defaultauthorizationform.html"><abbr title="src/Callback/DefaultAuthorizationForm.php">DefaultAuthorizationForm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
@ -285,7 +287,8 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<span class="phpdocumentor-signature__name">$logger</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -309,7 +312,7 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/DefaultAuthorizationForm.php"><a href="files/src-callback-defaultauthorizationform.html"><abbr title="src/Callback/DefaultAuthorizationForm.php">DefaultAuthorizationForm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Constructor</p>
@ -373,7 +376,7 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/DefaultAuthorizationForm.php"><a href="files/src-callback-defaultauthorizationform.html"><abbr title="src/Callback/DefaultAuthorizationForm.php">DefaultAuthorizationForm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">102</span>
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
@ -415,7 +418,7 @@ may make sense to create your own implementation of <code class="prettyprint">Au
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/DefaultAuthorizationForm.php"><a href="files/src-callback-defaultauthorizationform.html"><abbr title="src/Callback/DefaultAuthorizationForm.php">DefaultAuthorizationForm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Show Form</p>
@ -521,7 +524,7 @@ library, but, if stored on the access token, will be available to your app for u
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/DefaultAuthorizationForm.php"><a href="files/src-callback-defaultauthorizationform.html"><abbr title="src/Callback/DefaultAuthorizationForm.php">DefaultAuthorizationForm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Transform Authorization Code</p>

34
docs/classes/Taproot-IndieAuth-Callback-SingleUserPasswordAuthenticationCallback.html
View File

@ -321,7 +321,7 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
@ -331,7 +331,8 @@ $server = new IndieAuth\Server([
<span class="phpdocumentor-signature__name">$csrfKey</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -351,7 +352,7 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
@ -361,7 +362,8 @@ $server = new IndieAuth\Server([
<span class="phpdocumentor-signature__name">$formTemplate</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -381,7 +383,7 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
@ -391,7 +393,8 @@ $server = new IndieAuth\Server([
<span class="phpdocumentor-signature__name">$hashedPassword</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -411,7 +414,7 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
@ -421,7 +424,8 @@ $server = new IndieAuth\Server([
<span class="phpdocumentor-signature__name">$secret</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -441,7 +445,7 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
@ -451,7 +455,8 @@ $server = new IndieAuth\Server([
<span class="phpdocumentor-signature__name">$ttl</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -471,7 +476,7 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
@ -481,7 +486,8 @@ $server = new IndieAuth\Server([
<span class="phpdocumentor-signature__name">$user</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -505,7 +511,7 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
<span class="phpdocumentor-element-found-in__line">80</span>
</aside>
<p class="phpdocumentor-summary">Constructor</p>
@ -596,7 +602,7 @@ $server = new IndieAuth\Server([
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Callback/SingleUserPasswordAuthenticationCallback.php"><a href="files/src-callback-singleuserpasswordauthenticationcallback.html"><abbr title="src/Callback/SingleUserPasswordAuthenticationCallback.php">SingleUserPasswordAuthenticationCallback.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
<span class="phpdocumentor-element-found-in__line">103</span>
</aside>

17
docs/classes/Taproot-IndieAuth-IndieAuthException.html
View File

@ -739,7 +739,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/IndieAuthException.php"><a href="files/src-indieauthexception.html"><abbr title="src/IndieAuthException.php">IndieAuthException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
@ -749,7 +749,8 @@
<span class="phpdocumentor-signature__name">$request</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -773,7 +774,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/IndieAuthException.php"><a href="files/src-indieauthexception.html"><abbr title="src/IndieAuthException.php">IndieAuthException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
@ -829,7 +830,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/IndieAuthException.php"><a href="files/src-indieauthexception.html"><abbr title="src/IndieAuthException.php">IndieAuthException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
@ -861,7 +862,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/IndieAuthException.php"><a href="files/src-indieauthexception.html"><abbr title="src/IndieAuthException.php">IndieAuthException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
@ -893,7 +894,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/IndieAuthException.php"><a href="files/src-indieauthexception.html"><abbr title="src/IndieAuthException.php">IndieAuthException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">82</span>
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
@ -925,7 +926,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/IndieAuthException.php"><a href="files/src-indieauthexception.html"><abbr title="src/IndieAuthException.php">IndieAuthException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
@ -957,7 +958,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/IndieAuthException.php"><a href="files/src-indieauthexception.html"><abbr title="src/IndieAuthException.php">IndieAuthException.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">77</span>
<span class="phpdocumentor-element-found-in__line">78</span>
</aside>
<p class="phpdocumentor-summary">Trust Query Params</p>

9
docs/classes/Taproot-IndieAuth-Middleware-ClosureRequestHandler.html
View File

@ -178,7 +178,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/ClosureRequestHandler.php"><a href="files/src-middleware-closurerequesthandler.html"><abbr title="src/Middleware/ClosureRequestHandler.php">ClosureRequestHandler.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
@ -188,7 +188,8 @@
<span class="phpdocumentor-signature__name">$args</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -242,7 +243,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/ClosureRequestHandler.php"><a href="files/src-middleware-closurerequesthandler.html"><abbr title="src/Middleware/ClosureRequestHandler.php">ClosureRequestHandler.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">14</span>
<span class="phpdocumentor-element-found-in__line">15</span>
</aside>
@ -284,7 +285,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/ClosureRequestHandler.php"><a href="files/src-middleware-closurerequesthandler.html"><abbr title="src/Middleware/ClosureRequestHandler.php">ClosureRequestHandler.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">19</span>
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>

30
docs/classes/Taproot-IndieAuth-Middleware-DoubleSubmitCookieCsrfMiddleware.html
View File

@ -413,7 +413,7 @@ about customising the error response.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
@ -423,7 +423,8 @@ about customising the error response.</p>
<span class="phpdocumentor-signature__name">$attribute</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -443,7 +444,7 @@ about customising the error response.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
<span class="phpdocumentor-element-found-in__line">50</span>
</aside>
@ -473,7 +474,7 @@ about customising the error response.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
@ -483,7 +484,8 @@ about customising the error response.</p>
<span class="phpdocumentor-signature__name">$logger</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -503,7 +505,7 @@ about customising the error response.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
@ -513,7 +515,8 @@ about customising the error response.</p>
<span class="phpdocumentor-signature__name">$tokenLength</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -533,7 +536,7 @@ about customising the error response.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
@ -543,7 +546,8 @@ about customising the error response.</p>
<span class="phpdocumentor-signature__name">$ttl</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -567,7 +571,7 @@ about customising the error response.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Constructor</p>
@ -647,7 +651,7 @@ the return value of which will be returned as-is.</li>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
<span class="phpdocumentor-element-found-in__line">95</span>
</aside>
@ -696,7 +700,7 @@ the return value of which will be returned as-is.</li>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
@ -738,7 +742,7 @@ the return value of which will be returned as-is.</li>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php"><a href="files/src-middleware-doublesubmitcookiecsrfmiddleware.html"><abbr title="src/Middleware/DoubleSubmitCookieCsrfMiddleware.php">DoubleSubmitCookieCsrfMiddleware.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
<span class="phpdocumentor-element-found-in__line">118</span>
</aside>

9
docs/classes/Taproot-IndieAuth-Middleware-ResponseRequestHandler.html
View File

@ -171,7 +171,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/ResponseRequestHandler.php"><a href="files/src-middleware-responserequesthandler.html"><abbr title="src/Middleware/ResponseRequestHandler.php">ResponseRequestHandler.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">10</span>
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
@ -181,7 +181,8 @@
<span class="phpdocumentor-signature__name">$response</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -205,7 +206,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/ResponseRequestHandler.php"><a href="files/src-middleware-responserequesthandler.html"><abbr title="src/Middleware/ResponseRequestHandler.php">ResponseRequestHandler.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
@ -247,7 +248,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Middleware/ResponseRequestHandler.php"><a href="files/src-middleware-responserequesthandler.html"><abbr title="src/Middleware/ResponseRequestHandler.php">ResponseRequestHandler.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">16</span>
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>

51
docs/classes/Taproot-IndieAuth-Server.html
View File

@ -525,7 +525,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
<span class="phpdocumentor-element-found-in__line">107</span>
</aside>
@ -535,7 +535,8 @@ documentation for both handling methods for further documentation about them.</p
<span class="phpdocumentor-signature__name">$authorizationForm</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -555,7 +556,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">107</span>
<span class="phpdocumentor-element-found-in__line">110</span>
</aside>
@ -565,7 +566,8 @@ documentation for both handling methods for further documentation about them.</p
<span class="phpdocumentor-signature__name">$csrfMiddleware</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -585,7 +587,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
<span class="phpdocumentor-element-found-in__line">125</span>
</aside>
@ -595,7 +597,8 @@ documentation for both handling methods for further documentation about them.</p
<span class="phpdocumentor-signature__name">$exceptionTemplatePath</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -615,7 +618,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
<span class="phpdocumentor-element-found-in__line">119</span>
</aside>
@ -646,7 +649,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">118</span>
<span class="phpdocumentor-element-found-in__line">122</span>
</aside>
@ -677,7 +680,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
<span class="phpdocumentor-element-found-in__line">116</span>
</aside>
@ -708,7 +711,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">109</span>
<span class="phpdocumentor-element-found-in__line">113</span>
</aside>
@ -718,7 +721,8 @@ documentation for both handling methods for further documentation about them.</p
<span class="phpdocumentor-signature__name">$logger</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -738,7 +742,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
@ -748,7 +752,8 @@ documentation for both handling methods for further documentation about them.</p
<span class="phpdocumentor-signature__name">$requirePkce</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -768,7 +773,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">122</span>
<span class="phpdocumentor-element-found-in__line">128</span>
</aside>
@ -778,7 +783,8 @@ documentation for both handling methods for further documentation about them.</p
<span class="phpdocumentor-signature__name">$secret</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -798,7 +804,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">103</span>
<span class="phpdocumentor-element-found-in__line">104</span>
</aside>
@ -808,7 +814,8 @@ documentation for both handling methods for further documentation about them.</p
<span class="phpdocumentor-signature__name">$tokenStorage</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -832,7 +839,7 @@ documentation for both handling methods for further documentation about them.</p
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">201</span>
<span class="phpdocumentor-element-found-in__line">208</span>
</aside>
<p class="phpdocumentor-summary">Constructor</p>
@ -961,7 +968,7 @@ these old authorization codes will no longer be redeemable.</li>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">299</span>
<span class="phpdocumentor-element-found-in__line">306</span>
</aside>
@ -993,7 +1000,7 @@ these old authorization codes will no longer be redeemable.</li>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">338</span>
<span class="phpdocumentor-element-found-in__line">345</span>
</aside>
<p class="phpdocumentor-summary">Handle Authorization Endpoint Request</p>
@ -1068,7 +1075,7 @@ error behaviour, one way to do so is to subclass <code class="prettyprint">Serve
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">720</span>
<span class="phpdocumentor-element-found-in__line">728</span>
</aside>
<p class="phpdocumentor-summary">Handle Token Endpoint Request</p>
@ -1124,7 +1131,7 @@ error behaviour, one way to do so is to subclass <code class="prettyprint">Serve
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Server.php"><a href="files/src-server.html"><abbr title="src/Server.php">Server.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">824</span>
<span class="phpdocumentor-element-found-in__line">832</span>
</aside>
<p class="phpdocumentor-summary">Handle Exception</p>

51
docs/classes/Taproot-IndieAuth-Storage-FilesystemJsonStorage.html
View File

@ -389,7 +389,7 @@ will likely be superceded by the SQLite version.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
@ -399,7 +399,8 @@ will likely be superceded by the SQLite version.</p>
<span class="phpdocumentor-signature__name">$accessTokenTtl</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -419,7 +420,7 @@ will likely be superceded by the SQLite version.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
@ -429,7 +430,8 @@ will likely be superceded by the SQLite version.</p>
<span class="phpdocumentor-signature__name">$authCodeTtl</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -449,7 +451,7 @@ will likely be superceded by the SQLite version.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
@ -459,7 +461,8 @@ will likely be superceded by the SQLite version.</p>
<span class="phpdocumentor-signature__name">$logger</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -479,7 +482,7 @@ will likely be superceded by the SQLite version.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
@ -489,7 +492,8 @@ will likely be superceded by the SQLite version.</p>
<span class="phpdocumentor-signature__name">$path</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -509,7 +513,7 @@ will likely be superceded by the SQLite version.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
@ -519,7 +523,8 @@ will likely be superceded by the SQLite version.</p>
<span class="phpdocumentor-signature__name">$secret</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
@ -543,7 +548,7 @@ will likely be superceded by the SQLite version.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
@ -620,7 +625,7 @@ will likely be superceded by the SQLite version.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Create Authorization Code</p>
@ -705,7 +710,7 @@ throw exceptions.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">228</span>
<span class="phpdocumentor-element-found-in__line">259</span>
</aside>
@ -754,7 +759,7 @@ throw exceptions.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">169</span>
<span class="phpdocumentor-element-found-in__line">200</span>
</aside>
@ -786,7 +791,7 @@ throw exceptions.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">82</span>
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
<p class="phpdocumentor-summary">Exchange Authorization Code for Access Token</p>
@ -906,7 +911,7 @@ reference.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
<span class="phpdocumentor-element-found-in__line">228</span>
</aside>
@ -948,7 +953,7 @@ reference.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">147</span>
<span class="phpdocumentor-element-found-in__line">168</span>
</aside>
<p class="phpdocumentor-summary">Get Access Token</p>
@ -994,7 +999,7 @@ null if it is expired or invalid.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">242</span>
<span class="phpdocumentor-element-found-in__line">273</span>
</aside>
@ -1036,7 +1041,7 @@ null if it is expired or invalid.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">219</span>
<span class="phpdocumentor-element-found-in__line">250</span>
</aside>
@ -1085,7 +1090,7 @@ null if it is expired or invalid.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">163</span>
<span class="phpdocumentor-element-found-in__line">193</span>
</aside>
<p class="phpdocumentor-summary">Revoke Access Token</p>
@ -1131,7 +1136,7 @@ or false on error, including if the token did not exist.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
@ -1173,7 +1178,7 @@ or false on error, including if the token did not exist.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">271</span>
<span class="phpdocumentor-element-found-in__line">302</span>
</aside>
@ -1215,7 +1220,7 @@ or false on error, including if the token did not exist.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Storage/FilesystemJsonStorage.php"><a href="files/src-storage-filesystemjsonstorage.html"><abbr title="src/Storage/FilesystemJsonStorage.php">FilesystemJsonStorage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">247</span>
<span class="phpdocumentor-element-found-in__line">278</span>
</aside>