add docs

Author: michalsn

docs/assets/favicon.ico

@@ -0,0 +1,15 @@
+pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*!
+  Theme: GitHub Dark Dimmed
+  Description: Dark dimmed theme as seen on github.com
+  Author: github.com
+  Maintainer: @Hirse
+  Updated: 2021-05-15
+  Modified: 2022:12:27 by @michalsn
+
+  Colors taken from GitHub's CSS
+*/.hljs{color:#adbac7 !important;background-color:#22272e !important}.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-template-tag,.hljs-template-variable,.hljs-type,.hljs-variable.language_{color:#f47067}.hljs-title,.hljs-title.class_,.hljs-title.class_.inherited__,.hljs-title.function_{color:#dcbdfb}.hljs-attr,.hljs-attribute,.hljs-literal,.hljs-meta,.hljs-number,.hljs-operator,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-id,.hljs-variable{color:#6cb6ff}.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#96d0ff}.hljs-built_in,.hljs-symbol{color:#f69d50}.hljs-code,.hljs-comment,.hljs-formula{color:#768390}.hljs-name,.hljs-quote,.hljs-selector-pseudo,.hljs-selector-tag{color:#8ddb8c}.hljs-subst{color:#adbac7}.hljs-section{color:#316dca;font-weight:700}.hljs-bullet{color:#eac55f}.hljs-emphasis{color:#adbac7;font-style:italic}.hljs-strong{color:#adbac7;font-weight:700}.hljs-addition{color:#b4f1b4;background-color:#1b4721}.hljs-deletion{color:#ffd8d3;background-color:#78191b}
+
+[data-md-color-scheme="default"] {
+    --md-default-fg-color--lightest: #575757;
+    --md-default-fg-color--light: #959595;
+}

docs/assets/flame.svg

@@ -0,0 +1,3 @@
+document.addEventListener('DOMContentLoaded', (ev) => {
+    hljs.highlightAll();
+});

docs/assets/github-dark-dimmed.css

@@ -0,0 +1,26 @@
+# Commands
+
+Available options:
+
+- [publish](#publish)
+- [algorithms](#algorithms)
+
+### publish
+
+This command will publish configuration file to the APP namespace.
+
+```console
+php spark signedurl:publish
+```
+
+### algorithms
+
+This command will list all avaliable algorithms options to use with `$algorithm` config variable.`.
+
+```console
+php spark signedurl:algorithms
+```
+
+!!! warning
+
+    If you're not sure what you're doing please stay with the default option.

docs/assets/hljs.js

@@ -0,0 +1,89 @@
+# Configuration
+
+To make changes to the config file, we have to have our copy in the `app/Config/SignedUrl.php`. Luckily, this package comes with handy command that will make this easy.
+
+When we run:
+
+    php spark signedurl:publish
+
+We will get our copy ready for modifications.
+
+---
+
+Available options:
+
+- [$expirationTime](#expirationTime)
+- [$algorithm](#algorithm)
+- [$expirationKey](#expirationKey)
+- [$signatureKey](#signatureKey)
+- [$algorithmKey](#algorithmKey)
+- [$includeAlgorithmKey](#includeAlgorithmKey)
+- [$redirect](#redirect)
+- [$show404](#show404)
+
+### $expirationTime
+
+This setting allows us to set a fixed time after which the signed URL will expire.
+It's number of seconds in unix timestamp that will be added to the current date.
+
+By default, this is set to `null`.
+
+### $algorithm
+
+This setting allows us to set algorithm that will be used during signing the URLs.
+
+You can see the list of all available options when running command:
+
+    php spark signedurl:algorithms
+
+!!! warning
+
+    When you don't include used algorithm to the query string (default), then changing algorithm will result with invalidating all the generated URLs.
+
+### $expirationKey
+
+This is the name of the query string key, which will be responsible for storing the time after which the URL will expire.
+
+By default, this is set to `expires`.
+
+!!! note
+
+    Whatever name you will choose, treat it as a restricted name and don't use it as a part of the query string in your code.
+
+### $signatureKey
+
+This is the name of the query string key, which will be responsible for storing the signature by which the validity of the entire URL will be checked.
+
+By default, this is set to `signature`.
+
+!!! note
+
+    Whatever name you will choose, treat it as a restricted name and don't use it as a part of the query string in your code.
+
+### $algorithmKey
+
+This is the name of the query string key, which will be responsible for storing the algorithm by which the validity of the entire URL will be checked.
+
+By default, this is set to `algorithm`.
+
+!!! note
+
+    Whatever name you will choose, treat it as a restricted name and don't use it as a part of the query string in your code.
+
+### $includeAlgorithmKey
+
+This setting determines if the algorithm will be included to the query string of the generated URL.
+
+By default, this is set to `false`.
+
+### $redirect
+
+This setting is used in the Filter to determine whether we will redirect user to the previous page with the `error`, when URL will not be valid or expired.
+
+By default, this is set to `false`.
+
+### $show404
+
+This setting is used in the Filter to determine whether we will show a 404 page, when URL will not be valid or expired.
+
+By default, this is set to `false`.

docs/commands.md

@@ -0,0 +1,46 @@
+# Filters
+
+## Overview
+
+To validate signed URLs we can use build in filter. We can enable it in two simple steps.
+
+1. We have to add our filter to the `$aliases` array.
+2. And then define when filter should be fired up. In the example below we will assume it will be used when the first segment of the url will contain `signed-urls` string.
+
+```php
+// app/Config/Filters.php
+<?php
+
+...
+
+use Michalsn\CodeIgniterSignedUrl\Filters\SignedUrl;
+
+class Filters extends BaseConfig
+{
+    ...
+
+    public $aliases = [
+        ...
+        'signedurl' => SignedUrl::class
+    ];
+
+    ...
+
+    public $filters = [
+        'signedurl' => ['before' => ['signed-urls/*']],
+    ];
+}
+```
+
+## Options
+
+By default, this filter will throw `SignedUrlException` when the URL won't be signed or will be expired. But there are other options, and we can enable them by editing the config file:
+
+* We can redirect to the previous page
+* Or show 404 page
+
+More info you can find in the Config section.
+
+!!! note
+
+    Remember, that if the filter implementation doesn't suit you, you can always create your own, which will behave differently upon an error. You can also not use the filter at all and make the check in the controller.

docs/configuration.md

@@ -0,0 +1,13 @@
+# Helpers
+
+Available options:
+
+- [signedurl()](#signedurl)
+
+#### signedurl()
+
+This function returns the `SignedUrl` class instance.
+
+```php
+signedurl()->setExpiration(DAY)->siteUrl('controller/method');
+```

docs/filters.md

@@ -0,0 +1,18 @@
+# CodeIgniter Signed URL Documentation
+
+This library makes it easy to sign URLs in CodeIgniter 4 framework. It can be used to **prevent manual URL manipulation** or to **auto expiry links** that have been given to the end user.
+
+## Overview
+
+We can sign URLs very easy with two main methods that act similar to the helper functions known from CodeIgniter's URL helper.
+
+```php
+echo signedurl()->siteUrl('controller/method?query=string');
+// https://example.com/controller/method?query=string&signature=signature-goes-here
+```
+
+```php
+echo signedurl()->setExpiration(DAY * 2)->urlTo('namedRoute', 12);
+// https://example.com/route/name/12?expiration=1671980371&signature=signature-goes-here
+```
+

docs/helpers.md

@@ -0,0 +1,51 @@
+# Installation
+
+- [Composer Installation](#composer-installation)
+- [Manual Installation](#manual-installation)
+- [Generate encryption key](#generate-encryption-key)
+
+## Composer Installation
+
+The only thing you have to do is to run this command, and you're ready to go.
+
+```console
+composer require michalsn/codeigniter-signed-url
+```
+
+## Manual Installation
+
+In the example below we will assume, that files from this project will be located in `app/ThirdParty/signed-url` directory.
+
+Download this project and then enable it by editing the `app/Config/Autoload.php` file and adding the `Michalsn\CodeIgniterSignedUrl` namespace to the `$psr4` array. You also have to add `Common.php` to the `$files` array, like in the below example:
+
+```php
+<?php
+
+...
+
+public $psr4 = [
+    APP_NAMESPACE => APPPATH, // For custom app namespace
+    'Config'      => APPPATH . 'Config',
+    'Michalsn\CodeIgniterSignedUrl' => APPPATH . 'ThirdParty/signed-url/src',
+];
+
+...
+
+public $files = [
+    APPPATH . 'ThirdParty/signed-url/src/Common.php',
+];
+```
+
+## Generate encryption key
+
+Make sure that you have generated the encryption key. If not, please run command:
+
+```console
+php spark generate:key
+```
+
+!!! warning
+
+    Please remember that any change made to the `encryption key` after generating signed URLs will auto expire them.
+
+