diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 43 |
1 files changed, 41 insertions, 2 deletions
@@ -1,5 +1,44 @@ -# FreebeAuth +# SecD -Don't keep using expensive auth providers. FreebeAuth provides everything you need to hook up your web service with the most common auth providers and mechanisms. Use FreebeAuth with your language of choice. You can also use the Terraform template to launch FreebeAuth a service within your cloud environment so you really don't ever need to worry about auth again. +Don't keep using expensive auth providers. secd provides everything you need to hook up your web service with the most common auth providers and mechanisms. Use secd with your language of choice. You can also use the Terraform template to launch secd a service within your cloud environment so you really don't ever need to worry about auth again. ## Quick Start + + + +# Overview + +secd provides a simple way for you to authenticate and authorize users while maintaining complete control over the data and identity of your users. + +**Authentication** is the process of validating something is what it says it is. + +**Authorization** is the process of validating that something is allowed to do the thing it wants to do. + +secd is a comprehensive, simple, pluggable API that provides the following high level functionality. + +### Authentication + +Register a new **identity** which is an opaque handle pointing to anything in the service. You can save this handle next to user/device information. + +Save a new **authentication credential** for an **identity**. This is a secret of some sort that allows an identity to prove it is what it says it is. + +Create a new authentication credential in multiple ways by **initiating** an **authentication challenge** by means of: +- Email +- Oauth Provider +- SMS Number + +**validate** an authentication challenge to receive a new **token**. Give this token to the newly registered identity. For example, this token may be saved in a client's browser or some local cache. + +**check** if a token is still valid. Every time you check a token, a **token response** will be provided. This response automatically rotates tokens and revokes old tokens. This behavior is customizable. + +**create** API key sets which identity's may use to authenticate. These API key sets may have non-infinite expiry times. + +**revoke** an identity's authentication. This revokes all valid credentials associated with an identity. Alternatively, only revoke a token, all tokens, a specific API key or all API keys. + + + + + +### Authorization +tbd... +ALlow |