The reblocks-auth Reference Manual

Source Control

(GIT https://github.com/40ants/reblocks-auth)

Bug Tracker

License

Unlicense

Long Description

# reblocks-auth - A system to add an authentication to the Reblocks based web-site.

## REBLOCKS-AUTH ASDF System Details

* Description: A system to add an authentication to the Reblocks based web-site.
* Licence: Unlicense
* Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
* Homepage: [https://40ants.com/reblocks-auth/][e462]
* Bug tracker: [https://github.com/40ants/reblocks-auth/issues][4f85]
* Source control: [GIT][1668]
* Depends on: [alexandria][8236], [cl-strings][2ecb], [dexador][8347], [jonathan][6dd8], [local-time][46a1], [log4cl][7f8b], [mailgun][ef16], [mito][5b70], [quri][2103], [reblocks][184b], [reblocks-lass][28e0], [reblocks-ui][4376], [secret-values][cd18], [serapeum][c41d], [uuid][d6b3], [yason][aba2]

[![](https://github-actions.40ants.com/40ants/reblocks-auth/matrix.svg?only=ci.run-tests)][2ba2]

![](http://quickdocs.org/badge/reblocks-auth.svg)

Reblocks-auth is a system for adding authentication for your Reblocks application. It allows users to login using multiple ways. Right now GitHub is only supported but the list will be extended.

This system uses [Mito][c7c4] as a storage to store data about users and their data from service providers. Each user has a unique nickname and an optional email. Also, one or more identity providers can be bound to each user account.

## Installation

You can install this library from Quicklisp, but you want to receive updates quickly, then install it from Ultralisp.org:

“‘
(ql-dist:install-dist "http://dist.ultralisp.org/"
:prompt nil)
(ql:quickload :reblocks-auth)
“‘
<a id="x-28REBLOCKS-AUTH-DOCS-2FINDEX-3A-3A-40EXAMPLE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## Example App

I’ve made an example application to demonstrate how does [‘reblocks-auth‘][ac3a] system work.
To start this example application, run this code in the ‘REPL‘:

“‘
(asdf:load-system :reblocks-auth-example)

(reblocks-auth-example/server:start :port 8080)
“‘
When you’ll open the http://localhost:8080/ you will see this simple website:

![](https://storage.yandexcloud.net/40ants-blog-images/reblocks-auth-example.gif)

## Usage

This system provides a way for user authentifications. Each user is represented in the database
using [‘reblocks-auth/models:user‘][05f7] model user can be bound to one or more "social profiles" -
[‘reblocks-auth/models:social-profile‘][d9d6]. For example, if user logged in via GitHub, then
database will store one "user" record and one "social-profile" record. Each social profile
can hold additional information in it’s metadata slot.

To use this system, you have to define two routes which will be responsible for login and logout.
On each route you have to render either [‘reblocks-auth:login-processor‘][0dc2] or [‘reblocks-auth:logout-processor‘][4d0d] widgets.

Usually you can define your routes like this ([‘reblocks-navigation-widget:defroutes‘][5f0d] is used here):

“‘
(defroutes routes
("/" (make-page-frame
(make-landing-page)))
("/login"
(make-page-frame
(reblocks-auth:make-login-processor)))
("/logout"
(make-page-frame
(reblocks-auth:make-logout-processor))))
“‘
This code will render a set up buttons to login through enabled service providers.
Enabled service providers are listed in [‘reblocks-auth:*enabled-services*‘][ac4c] variable.

* renders buttons for enabled service providers calling [‘reblocks-auth/button:render‘][5d34] generic-function.
* service processor is executed when user clicks a "login" button. For example GitHub processor
redirects to https://github.com/login/oauth/authorize
* when user comes back to /login page, service processor gets or creates entries in the database
and stores current user in the session.
* after this, any code can retrieve current user by a call to [‘reblocks-auth/models:get-current-user‘][8c78].

Logout processor renders a "logout" button and when user clicks on it, removes user from the current session.

## API

### REBLOCKS-AUTH/AUTH

#### [package](7bb8) ‘reblocks-auth/auth‘

#### Generics

##### [generic-function](0067) ‘reblocks-auth/auth:authenticate‘ service &rest params &key code

Called when user had authenticated in the service and returned
to our site.

All ‘GET‘ arguments are collected into a plist and passed as params.

Should return two values a user and a flag denotifing if user was just created.

### REBLOCKS-AUTH/BUTTON

#### [package](c6c8) ‘reblocks-auth/button‘

#### Generics

##### [generic-function](2b0e) ‘reblocks-auth/button:render‘ service &key retpath

Renders a button for given service.
Service should be a keyword like :github or :facebook.

### REBLOCKS-AUTH/CONDITIONS

#### [package](957c) ‘reblocks-auth/conditions‘

#### Classes

##### UNABLE-TO-AUTHENTICATE

###### [condition](da77) ‘reblocks-auth/conditions:unable-to-authenticate‘ ()

**Readers**

###### [reader](da77) ‘reblocks-auth/conditions:get-message‘ (unable-to-authenticate) (:message)

###### [reader](da77) ‘reblocks-auth/conditions:get-reason‘ (unable-to-authenticate) (:reason = ’nil)

### REBLOCKS-AUTH/CORE

#### [package](8c4b) ‘reblocks-auth/core‘

#### Classes

##### LOGIN-PROCESSOR

###### [class](0603) ‘reblocks-auth/core:login-processor‘ (widget)

This widget should be rendered to process user’s login.

##### LOGOUT-PROCESSOR

###### [class](811c) ‘reblocks-auth/core:logout-processor‘ (widget)

This widget should be rendered to process user’s logout.

#### Generics

##### [generic-function](a47a) ‘reblocks-auth/core:render-login-page‘ app &key retpath

By default, renders a list of buttons for each allowed authentication method.

#### Functions

##### [function](7208) ‘reblocks-auth/core:make-login-processor‘

##### [function](9d8c) ‘reblocks-auth/core:make-logout-processor‘

##### [function](d46d) ‘reblocks-auth/core:render-buttons‘ &key retpath

Renders a row of buttons for enabled service providers.

Optionally you can specify ‘RETPATH‘ argument with an ‘URI‘ to return user
after login.

#### Variables

##### [variable](52c4) ‘reblocks-auth/core:*allow-new-accounts-creation*‘ t

When True, a new account will be created. Otherwise only already existing users can log in.

##### [variable](09e2) ‘reblocks-auth/core:*enabled-services*‘ (:github)

Set this variable to limit a services available to login through.

##### [variable](c9c9) ‘reblocks-auth/core:*login-hooks*‘ nil

Append a funcallable handlers which accept single argument - logged user.

### REBLOCKS-AUTH/ERRORS

#### [package](09d9) ‘reblocks-auth/errors‘

#### Classes

##### NICKNAME-IS-NOT-AVAILABLE

###### [condition](163d) ‘reblocks-auth/errors:nickname-is-not-available‘ (error)

Signalled when there is already a user with given nickname.

### REBLOCKS-AUTH/GITHUB

#### [package](b908) ‘reblocks-auth/github‘

#### Functions

##### [function](e341) ‘reblocks-auth/github:get-scopes‘

Returns current user’s scopes.

##### [function](8cc0) ‘reblocks-auth/github:get-token‘

Returns current user’s GitHub token.

##### [function](2c83) ‘reblocks-auth/github:render-button‘ &KEY (CLASS "button small") (SCOPES \*DEFAULT-SCOPES\*) (TEXT "Grant permissions") (RETPATH (GET-URI))

Renders a button to request more scopes.

#### Variables

##### [variable](2dd0) ‘reblocks-auth/github:*client-id*‘ nil

‘OA‘uth client id

##### [variable](dea4) ‘reblocks-auth/github:*default-scopes*‘ ("user:email")

A listo of default scopes to request from GitHub.

##### [variable](1344) ‘reblocks-auth/github:*secret*‘ nil

‘OA‘uth secret. It might be a string or secret-values:secret-value.

### REBLOCKS-AUTH/MODELS

#### [package](f4b8) ‘reblocks-auth/models‘

#### Classes

##### SOCIAL-PROFILE

###### [class](8a32) ‘reblocks-auth/models:social-profile‘ (serial-pk-mixin dao-class record-timestamps-mixin)

Represents a User’s link to a social service.
User can be bound to multiple social services.

**Readers**

###### [reader](8d80) ‘reblocks-auth/models:profile-metadata‘ (social-profile) (:metadata :params)

###### [reader](8673) ‘reblocks-auth/models:profile-service‘ (social-profile) (:service)

###### [reader](1119) ‘reblocks-auth/models:profile-service-user-id‘ (social-profile) (:service-user-id)

###### [reader] ‘reblocks-auth/models:profile-user‘ (social-profile) (:user)

A [‘user‘][05f7] instance, bound to the [‘social-profile‘][d9d6].

**Accessors**

###### [accessor](8d80) ‘reblocks-auth/models:profile-metadata‘ (social-profile) (:metadata :params)

##### USER

###### [class](96a5) ‘reblocks-auth/models:user‘ (serial-pk-mixin dao-class record-timestamps-mixin)

This class stores basic information about user - it’s nickname and email.
Additional information is stored inside [‘social-profile‘][d9d6] instances.

**Readers**

###### [reader](4133) ‘reblocks-auth/models:get-email‘ (user) (:email = nil)

###### [reader](4d04) ‘reblocks-auth/models:get-nickname‘ (user) (:nickname)

#### Functions

##### [function](6436) ‘reblocks-auth/models:anonymous-p‘ user

##### [function](7835) ‘reblocks-auth/models:change-email‘ user email

##### [function](9aca) ‘reblocks-auth/models:change-nickname‘ new-nickname

Changes nickname of the current user.

##### [function](9a92) ‘reblocks-auth/models:create-social-user‘ service service-user-id &rest metadata &key email

##### [function](3bcf) ‘reblocks-auth/models:find-social-user‘ service service-user-id

##### [function](704e) ‘reblocks-auth/models:get-all-users‘

##### [function](34e6) ‘reblocks-auth/models:get-current-user‘

Returns current user or ‘NIL‘.

##### [function](2c50) ‘reblocks-auth/models:get-user-by-email‘ email

Returns a user with given email.

##### [function](6613) ‘reblocks-auth/models:get-user-by-nickname‘ nickname

Returns a user with given email.

##### [function](c696) ‘reblocks-auth/models:user-social-profiles‘ user

Returns a list of social profiles, bound to the user.

#### Variables

##### [variable](9936) ‘reblocks-auth/models:*user-class*‘ user

Allows to redefine a model, for users to be created by the reblocks-auth.

### REBLOCKS-AUTH/PROVIDERS/EMAIL/MAILGUN

#### [package](1c21) ‘reblocks-auth/providers/email/mailgun‘

#### Macros

##### [macro](6749) ‘reblocks-auth/providers/email/mailgun:define-code-sender‘ NAME (FROM-EMAIL URL-VAR &KEY (SUBJECT "Authentication code")) &BODY HTML-TEMPLATE-BODY

### REBLOCKS-AUTH/PROVIDERS/EMAIL/MODELS

#### [package](6c56) ‘reblocks-auth/providers/email/models‘

#### Classes

##### REGISTRATION-CODE

###### [class](ab7d) ‘reblocks-auth/providers/email/models:registration-code‘ (serial-pk-mixin dao-class record-timestamps-mixin)

This model stores a code sent to an email for signup or log in.

**Readers**

###### [reader](9bc4) ‘reblocks-auth/providers/email/models:registration-code‘ (registration-code) (:code)

###### [reader](4c67) ‘reblocks-auth/providers/email/models:registration-email‘ (registration-code) (:email)

User’s email.

###### [reader](0303) ‘reblocks-auth/providers/email/models:valid-until‘ (registration-code) (:valid-until)

Expiration time.

#### Functions

##### [function](0874) ‘reblocks-auth/providers/email/models:send-code‘ email &key retpath send-callback

Usually you should define a global callback using
[‘reblocks-auth/providers/email/mailgun:define-code-sender‘][f455] macro,
but you can provide an alternative function to handle
email sending.

#### Variables

##### [variable](3afd) ‘reblocks-auth/providers/email/models:*send-code-callback*‘ -unbound-

Set this variable to a function of one argument of class [‘registration-code‘][1573].
It should send a registration code using template, suitable for your website.

### REBLOCKS-AUTH/PROVIDERS/EMAIL/PROCESSING

#### [package](08fb) ‘reblocks-auth/providers/email/processing‘

#### Classes

##### REQUEST-CODE-FORM

###### [class](a659) ‘reblocks-auth/providers/email/processing:request-code-form‘ (widget)

**Readers**

###### [reader](a15a) ‘reblocks-auth/providers/email/processing:retpath‘ (request-code-form) (:retpath)

###### [reader](a2e3) ‘reblocks-auth/providers/email/processing:sent‘ (request-code-form) (= nil)

**Accessors**

###### [accessor](a2e3) ‘reblocks-auth/providers/email/processing:sent‘ (request-code-form) (= nil)

#### Generics

##### [generic-function](3f68) ‘reblocks-auth/providers/email/processing:form-css-classes‘ widget

##### [generic-function](cfbb) ‘reblocks-auth/providers/email/processing:render-email-input‘ widget

##### [generic-function](30f6) ‘reblocks-auth/providers/email/processing:render-sent-message‘ widget

##### [generic-function](951e) ‘reblocks-auth/providers/email/processing:render-submit-button‘ widget

#### Variables

##### [variable](1bb0) ‘reblocks-auth/providers/email/processing:*recaptcha-secret-key*‘ nil

Set this variable to a secret key, generated by Google reCaptcha.

##### [variable](10f5) ‘reblocks-auth/providers/email/processing:*recaptcha-site-key*‘ nil

Set this variable to a site key, generated by Google reCaptcha.

### REBLOCKS-AUTH/PROVIDERS/EMAIL/RESEND

#### [package](dfa3) ‘reblocks-auth/providers/email/resend‘

#### Functions

##### [function](32d2) ‘reblocks-auth/providers/email/resend:make-code-sender‘ thunk &key base-uri

Makes a function which will prepare params and call ‘THUNK‘ function with email and ‘URL‘.

Usually you don’t need to call this function directly and you can use just [‘define-code-sender‘][fc31] macro.

#### Macros

##### [macro](04c6) ‘reblocks-auth/providers/email/resend:define-code-sender‘ NAME (FROM-EMAIL URL-VAR &KEY (SUBJECT "Authentication code")) &BODY HTML-TEMPLATE-BODY

## Roadmap

* Add support for authentication by a link sent to the email.
* Add ability to bind multiple service providers to a single user.

[e462]: https://40ants.com/reblocks-auth/
[ac3a]: https://40ants.com/reblocks-auth/#x-28-23A-28-2813-29-20BASE-CHAR-20-2E-20-22reblocks-auth-22-29-20ASDF-2FSYSTEM-3ASYSTEM-29
[5d34]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FBUTTON-3ARENDER-20GENERIC-FUNCTION-29
[ac4c]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FCORE-3A-2AENABLED-SERVICES-2A-20-28VARIABLE-29-29
[0dc2]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FCORE-3ALOGIN-PROCESSOR-20CLASS-29
[4d0d]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FCORE-3ALOGOUT-PROCESSOR-20CLASS-29
[8c78]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FMODELS-3AGET-CURRENT-USER-20FUNCTION-29
[d9d6]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FMODELS-3ASOCIAL-PROFILE-20CLASS-29
[05f7]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FMODELS-3AUSER-20CLASS-29
[f455]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FPROVIDERS-2FEMAIL-2FMAILGUN-3ADEFINE-CODE-SENDER-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[1573]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FPROVIDERS-2FEMAIL-2FMODELS-3AREGISTRATION-CODE-20CLASS-29
[fc31]: https://40ants.com/reblocks-auth/#x-28REBLOCKS-AUTH-2FPROVIDERS-2FEMAIL-2FRESEND-3ADEFINE-CODE-SENDER-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[5f0d]: https://40ants.com/reblocks-navigation-widget/#x-28REBLOCKS-NAVIGATION-WIDGET-3ADEFROUTES-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[1668]: https://github.com/40ants/reblocks-auth
[2ba2]: https://github.com/40ants/reblocks-auth/actions
[7bb8]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/auth.lisp#L1
[0067]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/auth.lisp#L8
[c6c8]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/button.lisp#L1
[2b0e]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/button.lisp#L10
[957c]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/conditions.lisp#L1
[da77]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/conditions.lisp#L10
[8c4b]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L1
[a47a]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L143
[09e2]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L43
[c9c9]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L47
[52c4]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L51
[0603]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L55
[811c]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L60
[7208]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L65
[9d8c]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L69
[d46d]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/core.lisp#L80
[09d9]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/errors.lisp#L1
[163d]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/errors.lisp#L7
[b908]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/github.lisp#L1
[8cc0]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/github.lisp#L144
[e341]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/github.lisp#L149
[2dd0]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/github.lisp#L36
[1344]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/github.lisp#L40
[dea4]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/github.lisp#L44
[2c83]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/github.lisp#L82
[f4b8]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L1
[704e]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L106
[3bcf]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L110
[9a92]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L119
[34e6]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L146
[c696]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L152
[6436]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L165
[2c50]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L169
[6613]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L174
[9aca]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L179
[7835]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L193
[96a5]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L37
[4d04]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L38
[4133]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L44
[9936]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L55
[8a32]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L59
[8673]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L68
[1119]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L74
[8d80]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/models.lisp#L77
[1c21]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/mailgun.lisp#L1
[6749]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/mailgun.lisp#L44
[6c56]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/models.lisp#L1
[3afd]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/models.lisp#L21
[ab7d]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/models.lisp#L43
[4c67]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/models.lisp#L44
[9bc4]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/models.lisp#L48
[0303]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/models.lisp#L52
[0874]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/models.lisp#L78
[08fb]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L1
[30f6]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L157
[cfbb]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L173
[951e]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L181
[3f68]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L189
[10f5]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L42
[1bb0]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L45
[a659]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L49
[a15a]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L50
[a2e3]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/processing.lisp#L52
[dfa3]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/resend.lisp#L1
[32d2]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/resend.lisp#L16
[04c6]: https://github.com/40ants/reblocks-auth/blob/8f371016e7c289fd2d78a7a2b530c8370e15575b/src/providers/email/resend.lisp#L44
[4f85]: https://github.com/40ants/reblocks-auth/issues
[c7c4]: https://github.com/fukamachi/mito
[8236]: https://quickdocs.org/alexandria
[2ecb]: https://quickdocs.org/cl-strings
[8347]: https://quickdocs.org/dexador
[6dd8]: https://quickdocs.org/jonathan
[46a1]: https://quickdocs.org/local-time
[7f8b]: https://quickdocs.org/log4cl
[ef16]: https://quickdocs.org/mailgun
[5b70]: https://quickdocs.org/mito
[2103]: https://quickdocs.org/quri
[184b]: https://quickdocs.org/reblocks
[28e0]: https://quickdocs.org/reblocks-lass
[4376]: https://quickdocs.org/reblocks-ui
[cd18]: https://quickdocs.org/secret-values
[c41d]: https://quickdocs.org/serapeum
[d6b3]: https://quickdocs.org/uuid
[aba2]: https://quickdocs.org/yason

* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]

Version

0.11.0

Defsystem Dependency

40ants-asdf-system (system).

Dependencies

reblocks-auth/core (system).
reblocks-auth/github (system).
reblocks-auth/providers/email/processing (system).
reblocks-auth/providers/email/mailgun (system).
reblocks-auth/models (system).

Source

Next: reblocks-auth/button, Previous: reblocks-auth, Up: Systems [Contents][Index]

2.2 `reblocks-auth/core`

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

Home Page

Source Control

(GIT https://github.com/40ants/reblocks-auth)

Bug Tracker

License

Unlicense

Dependencies

log4cl (system).
reblocks-lass (system).
reblocks-auth/button (system).
reblocks-auth/auth (system).
reblocks/response (system).
reblocks/request (system).
reblocks/widget (system).
reblocks-auth/utils (system).
reblocks-auth/conditions (system).
reblocks/html (system).
reblocks-auth/models (system).
reblocks/dependencies (system).
reblocks/app (system).
reblocks/session (system).

Source

Next: reblocks-auth/auth, Previous: reblocks-auth/core, Up: Systems [Contents][Index]

2.3 `reblocks-auth/button`

Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
Home Page: https://40ants.com/reblocks-auth/
Source Control: (GIT https://github.com/40ants/reblocks-auth)
Bug Tracker: https://github.com/40ants/reblocks-auth/issues
License: Unlicense
Dependency: reblocks/html (system).
Source: reblocks-auth.asd.

Next: reblocks-auth/utils, Previous: reblocks-auth/button, Up: Systems [Contents][Index]

2.4 `reblocks-auth/auth`

Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
Home Page: https://40ants.com/reblocks-auth/
Source Control: (GIT https://github.com/40ants/reblocks-auth)
Bug Tracker: https://github.com/40ants/reblocks-auth/issues
License: Unlicense
Source: reblocks-auth.asd.

Next: reblocks-auth/conditions, Previous: reblocks-auth/auth, Up: Systems [Contents][Index]

2.5 `reblocks-auth/utils`

Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
Home Page: https://40ants.com/reblocks-auth/
Source Control: (GIT https://github.com/40ants/reblocks-auth)
Bug Tracker: https://github.com/40ants/reblocks-auth/issues
License: Unlicense
Dependency: alexandria (system).
Source: reblocks-auth.asd.

Next: reblocks-auth/models, Previous: reblocks-auth/utils, Up: Systems [Contents][Index]

2.6 `reblocks-auth/conditions`

Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
Home Page: https://40ants.com/reblocks-auth/
Source Control: (GIT https://github.com/40ants/reblocks-auth)
Bug Tracker: https://github.com/40ants/reblocks-auth/issues
License: Unlicense
Source: reblocks-auth.asd.

Next: reblocks-auth/errors, Previous: reblocks-auth/conditions, Up: Systems [Contents][Index]

2.7 `reblocks-auth/models`

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

Home Page

Source Control

(GIT https://github.com/40ants/reblocks-auth)

Bug Tracker

License

Unlicense

Dependencies

jonathan (system).
reblocks/session (system).
alexandria (system).
mito (system).
reblocks-auth/errors (system).

Source

Next: reblocks-auth/github, Previous: reblocks-auth/models, Up: Systems [Contents][Index]

2.8 `reblocks-auth/errors`

Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
Home Page: https://40ants.com/reblocks-auth/
Source Control: (GIT https://github.com/40ants/reblocks-auth)
Bug Tracker: https://github.com/40ants/reblocks-auth/issues
License: Unlicense
Source: reblocks-auth.asd.

Next: reblocks-auth/providers/email/processing, Previous: reblocks-auth/errors, Up: Systems [Contents][Index]

2.9 `reblocks-auth/github`

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

Home Page

Source Control

(GIT https://github.com/40ants/reblocks-auth)

Bug Tracker

License

Unlicense

Dependencies

dexador (system).
log4cl (system).
jonathan (system).
reblocks-auth/button (system).
reblocks-auth/auth (system).
reblocks/html (system).
reblocks-auth/conditions (system).
reblocks-auth/models (system).
reblocks/response (system).
cl-strings (system).
quri (system).
reblocks/request (system).
secret-values (system).
reblocks/session (system).

Source

Next: reblocks-auth/providers/email/models, Previous: reblocks-auth/github, Up: Systems [Contents][Index]

2.10 `reblocks-auth/providers/email/processing`

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

Home Page

Source Control

(GIT https://github.com/40ants/reblocks-auth)

Bug Tracker

License

Unlicense

Dependencies

reblocks-auth/providers/email/models (system).
reblocks/html (system).
dexador (system).
log4cl (system).
reblocks/widget (system).
reblocks-auth/button (system).
reblocks-ui/form (system).
reblocks-ui/popup (system).
reblocks-lass (system).
reblocks/dependencies (system).
reblocks-auth/core (system).
reblocks-auth/models (system).
serapeum (system).
reblocks-auth/auth (system).
reblocks/request (system).
yason (system).

Source

Next: reblocks-auth/providers/email/mailgun, Previous: reblocks-auth/providers/email/processing, Up: Systems [Contents][Index]

2.11 `reblocks-auth/providers/email/models`

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

Home Page

Source Control

(GIT https://github.com/40ants/reblocks-auth)

Bug Tracker

License

Unlicense

Dependencies

log4cl (system).
local-time (system).
uuid (system).
mito (system).

Source

Previous: reblocks-auth/providers/email/models, Up: Systems [Contents][Index]

2.12 `reblocks-auth/providers/email/mailgun`

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

Home Page

Source Control

(GIT https://github.com/40ants/reblocks-auth)

Bug Tracker

License

Unlicense

Dependencies

log4cl (system).
mailgun (system).
reblocks/response (system).
alexandria (system).
reblocks-auth/providers/email/models (system).
quri (system).

Source

Next: Packages, Previous: Systems, Up: The reblocks-auth Reference Manual [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

reblocks-auth/reblocks-auth.asd
reblocks-auth/core/file-type.lisp
reblocks-auth/button/file-type.lisp
reblocks-auth/auth/file-type.lisp
reblocks-auth/utils/file-type.lisp
reblocks-auth/conditions/file-type.lisp
reblocks-auth/models/file-type.lisp
reblocks-auth/errors/file-type.lisp
reblocks-auth/github/file-type.lisp
reblocks-auth/providers/email/processing/file-type.lisp
reblocks-auth/providers/email/models/file-type.lisp
reblocks-auth/providers/email/mailgun/file-type.lisp

Next: reblocks-auth/core/file-type.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `reblocks-auth/reblocks-auth.asd`

Source

Parent Component

reblocks-auth (system).

ASDF Systems

reblocks-auth.
reblocks-auth/core.
reblocks-auth/button.
reblocks-auth/auth.
reblocks-auth/utils.
reblocks-auth/conditions.
reblocks-auth/models.
reblocks-auth/errors.
reblocks-auth/github.
reblocks-auth/providers/email/processing.
reblocks-auth/providers/email/models.
reblocks-auth/providers/email/mailgun.

Next: reblocks-auth/button/file-type.lisp, Previous: reblocks-auth/reblocks-auth.asd, Up: Lisp [Contents][Index]

3.1.2 `reblocks-auth/core/file-type.lisp`

Source

Parent Component

reblocks-auth/core (system).

Packages

Public Interface

*allow-new-accounts-creation* (special variable).
*enabled-services* (special variable).
*login-hooks* (special variable).
get-dependencies (method).
login-processor (class).
logout-processor (class).
make-login-processor (function).
make-logout-processor (function).
render (method).
render (method).
render-buttons (function).
render-login-page (generic function).

Internals

reach-goal (generic function).

Next: reblocks-auth/auth/file-type.lisp, Previous: reblocks-auth/core/file-type.lisp, Up: Lisp [Contents][Index]

3.1.3 `reblocks-auth/button/file-type.lisp`

Source: reblocks-auth.asd.
Parent Component: reblocks-auth/button (system).
Packages: reblocks-auth/button.
Public Interface: render (generic function).

Next: reblocks-auth/utils/file-type.lisp, Previous: reblocks-auth/button/file-type.lisp, Up: Lisp [Contents][Index]

3.1.4 `reblocks-auth/auth/file-type.lisp`

Source: reblocks-auth.asd.
Parent Component: reblocks-auth/auth (system).
Packages: reblocks-auth/auth.
Public Interface: authenticate (generic function).

Next: reblocks-auth/conditions/file-type.lisp, Previous: reblocks-auth/auth/file-type.lisp, Up: Lisp [Contents][Index]

3.1.5 `reblocks-auth/utils/file-type.lisp`

Source

Parent Component

reblocks-auth/utils (system).

Packages

reblocks-auth/utils.

Internals

keywordify (function).
to-plist (function).

Next: reblocks-auth/models/file-type.lisp, Previous: reblocks-auth/utils/file-type.lisp, Up: Lisp [Contents][Index]

3.1.6 `reblocks-auth/conditions/file-type.lisp`

Source

Parent Component

reblocks-auth/conditions (system).

Packages

Public Interface

get-message (reader method).
get-reason (reader method).
unable-to-authenticate (condition).

Next: reblocks-auth/errors/file-type.lisp, Previous: reblocks-auth/conditions/file-type.lisp, Up: Lisp [Contents][Index]

3.1.7 `reblocks-auth/models/file-type.lisp`

Source

Parent Component

reblocks-auth/models (system).

Packages

Public Interface

*user-class* (special variable).
anonymous-p (function).
change-email (function).
change-nickname (function).
create-social-user (function).
find-social-user (function).
get-all-users (function).
get-current-user (function).
(setf get-current-user) (function).
get-email (reader method).
get-nickname (reader method).
get-user-by-email (function).
get-user-by-nickname (function).
print-object (method).
print-object (method).
profile-metadata (reader method).
(setf profile-metadata) (writer method).
profile-service (reader method).
profile-service-user-id (reader method).
social-profile (class).
user (class).
user-social-profiles (function).

Next: reblocks-auth/github/file-type.lisp, Previous: reblocks-auth/models/file-type.lisp, Up: Lisp [Contents][Index]

3.1.8 `reblocks-auth/errors/file-type.lisp`

Source: reblocks-auth.asd.
Parent Component: reblocks-auth/errors (system).
Packages: reblocks-auth/errors.
Public Interface: nickname-is-not-available (condition).

Next: reblocks-auth/providers/email/processing/file-type.lisp, Previous: reblocks-auth/errors/file-type.lisp, Up: Lisp [Contents][Index]

3.1.9 `reblocks-auth/github/file-type.lisp`

Source

Parent Component

reblocks-auth/github (system).

Packages

reblocks-auth/github.

Public Interface

*client-id* (special variable).
*default-scopes* (special variable).
*secret* (special variable).
authenticate (method).
get-scopes (function).
get-token (function).
render (method).
render-button (function).

Internals

get-oauth-token-by (function).
make-authentication-url (function).
make-default-redirect-uri (function).

Next: reblocks-auth/providers/email/models/file-type.lisp, Previous: reblocks-auth/github/file-type.lisp, Up: Lisp [Contents][Index]

3.1.10 `reblocks-auth/providers/email/processing/file-type.lisp`

Source

Parent Component

reblocks-auth/providers/email/processing (system).

Packages

Public Interface

*recaptcha-secret-key* (special variable).
*recaptcha-site-key* (special variable).
authenticate (method).
form-css-classes (generic function).
get-dependencies (method).
render (method).
render (method).
render-email-input (generic function).
render-popup-content (method).
render-sent-message (generic function).
render-submit-button (generic function).
request-code-form (class).
retpath (reader method).
sent (reader method).
(setf sent) (writer method).

Internals

form (reader method).
new-accounts-are-prohibited (condition).
request-code-form-for-popup (class).
request-code-popup (class).
verify-recaptcha (function).

Next: reblocks-auth/providers/email/mailgun/file-type.lisp, Previous: reblocks-auth/providers/email/processing/file-type.lisp, Up: Lisp [Contents][Index]

3.1.11 `reblocks-auth/providers/email/models/file-type.lisp`

Source

Parent Component

reblocks-auth/providers/email/models (system).

Packages

Public Interface

*send-code-callback* (special variable).
print-object (method).
registration-code (reader method).
registration-code (class).
registration-email (reader method).
send-code (function).
valid-until (reader method).

Internals

*code-ttl* (special variable).
check-registration-code (function).
code-expired (condition).
code-unknown (condition).
get-code (reader method).
get-code (reader method).
make-registration-code (function).

Previous: reblocks-auth/providers/email/models/file-type.lisp, Up: Lisp [Contents][Index]

3.1.12 `reblocks-auth/providers/email/mailgun/file-type.lisp`

Source: reblocks-auth.asd.
Parent Component: reblocks-auth/providers/email/mailgun (system).
Packages: reblocks-auth/providers/email/mailgun.
Public Interface: define-code-sender (macro).
Internals: make-code-sender (function).

Next: Definitions, Previous: Files, Up: The reblocks-auth Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

reblocks-auth/providers/email/processing
reblocks-auth/conditions
reblocks-auth/models
reblocks-auth/button
reblocks-auth/providers/email/mailgun
reblocks-auth/auth
reblocks-auth/github
reblocks-auth/errors
reblocks-auth/utils
reblocks-auth/providers/email/models
reblocks-auth/core

Next: reblocks-auth/conditions, Previous: Packages, Up: Packages [Contents][Index]

4.1 `reblocks-auth/providers/email/processing`

Source

Use List

common-lisp.

Public Interface

*recaptcha-secret-key* (special variable).
*recaptcha-site-key* (special variable).
form-css-classes (generic function).
render-email-input (generic function).
render-sent-message (generic function).
render-submit-button (generic function).
request-code-form (class).
retpath (generic reader).
sent (generic reader).
(setf sent) (generic writer).

Internals

form (generic reader).
new-accounts-are-prohibited (condition).
request-code-form-for-popup (class).
request-code-popup (class).
verify-recaptcha (function).

Next: reblocks-auth/models, Previous: reblocks-auth/providers/email/processing, Up: Packages [Contents][Index]

4.2 `reblocks-auth/conditions`

Source

Use List

common-lisp.

Public Interface

get-message (generic reader).
get-reason (generic reader).
unable-to-authenticate (condition).

Next: reblocks-auth/button, Previous: reblocks-auth/conditions, Up: Packages [Contents][Index]

4.3 `reblocks-auth/models`

Source

Use List

common-lisp.

Public Interface

*user-class* (special variable).
anonymous-p (function).
change-email (function).
change-nickname (function).
create-social-user (function).
find-social-user (function).
get-all-users (function).
get-current-user (function).
(setf get-current-user) (function).
get-email (generic reader).
get-nickname (generic reader).
get-user-by-email (function).
get-user-by-nickname (function).
profile-metadata (generic reader).
(setf profile-metadata) (generic writer).
profile-service (generic reader).
profile-service-user-id (generic reader).
profile-user (generic reader).
social-profile (class).
user (class).
user-social-profiles (function).

Next: reblocks-auth/providers/email/mailgun, Previous: reblocks-auth/models, Up: Packages [Contents][Index]

4.4 `reblocks-auth/button`

Source: file-type.lisp.
Use List: common-lisp.
Public Interface: render (generic function).

Next: reblocks-auth/auth, Previous: reblocks-auth/button, Up: Packages [Contents][Index]

4.5 `reblocks-auth/providers/email/mailgun`

Source: file-type.lisp.
Use List: common-lisp.
Public Interface: define-code-sender (macro).
Internals: make-code-sender (function).

Next: reblocks-auth/github, Previous: reblocks-auth/providers/email/mailgun, Up: Packages [Contents][Index]

4.6 `reblocks-auth/auth`

Source: file-type.lisp.
Use List: common-lisp.
Public Interface: authenticate (generic function).

Next: reblocks-auth/errors, Previous: reblocks-auth/auth, Up: Packages [Contents][Index]

4.7 `reblocks-auth/github`

Source

Use List

common-lisp.

Public Interface

*client-id* (special variable).
*default-scopes* (special variable).
*secret* (special variable).
get-scopes (function).
get-token (function).
render-button (function).

Internals

get-oauth-token-by (function).
make-authentication-url (function).
make-default-redirect-uri (function).

Next: reblocks-auth/utils, Previous: reblocks-auth/github, Up: Packages [Contents][Index]

4.8 `reblocks-auth/errors`

Source: file-type.lisp.
Use List: common-lisp.
Public Interface: nickname-is-not-available (condition).

Next: reblocks-auth/providers/email/models, Previous: reblocks-auth/errors, Up: Packages [Contents][Index]

4.9 `reblocks-auth/utils`

Source

Use List

common-lisp.

Internals

keywordify (function).
to-plist (function).

Next: reblocks-auth/core, Previous: reblocks-auth/utils, Up: Packages [Contents][Index]

4.10 `reblocks-auth/providers/email/models`

Source

Use List

common-lisp.

Public Interface

*send-code-callback* (special variable).
registration-code (generic reader).
registration-code (class).
registration-email (generic reader).
send-code (function).
valid-until (generic reader).

Internals

*code-ttl* (special variable).
check-registration-code (function).
code-expired (condition).
code-unknown (condition).
get-code (generic reader).
make-registration-code (function).

Previous: reblocks-auth/providers/email/models, Up: Packages [Contents][Index]

4.11 `reblocks-auth/core`

Source

Nickname

reblocks-auth

Use List

common-lisp.

Public Interface

*allow-new-accounts-creation* (special variable).
*enabled-services* (special variable).
*login-hooks* (special variable).
login-processor (class).
logout-processor (class).
make-login-processor (function).
make-logout-processor (function).
render-buttons (function).
render-login-page (generic function).

Internals

reach-goal (generic function).

Next: Indexes, Previous: Packages, Up: The reblocks-auth Reference Manual [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Special variables

Special Variable: *allow-new-accounts-creation* ¶

When True, a new account will be created. Otherwise only already existing users can log in.

Package: reblocks-auth/core.
Source: file-type.lisp.

Special Variable: *client-id* ¶

OAuth client id

Package: reblocks-auth/github.
Source: file-type.lisp.

Special Variable: *default-scopes* ¶

A listo of default scopes to request from GitHub.

Package: reblocks-auth/github.
Source: file-type.lisp.

Special Variable: *enabled-services* ¶

Set this variable to limit a services available to login through.

Package: reblocks-auth/core.
Source: file-type.lisp.

Special Variable: *login-hooks* ¶

Append a funcallable handlers which accept single argument - logged user.

Package: reblocks-auth/core.
Source: file-type.lisp.

Special Variable: *recaptcha-secret-key* ¶

Set this variable to a secret key, generated by Google reCaptcha.

Package: reblocks-auth/providers/email/processing.
Source: file-type.lisp.

Special Variable: *recaptcha-site-key* ¶

Set this variable to a site key, generated by Google reCaptcha.

Package: reblocks-auth/providers/email/processing.
Source: file-type.lisp.

Special Variable: *secret* ¶

OAuth secret. It might be a string or secret-values:secret-value.

Package: reblocks-auth/github.
Source: file-type.lisp.

Special Variable: *send-code-callback* ¶

Set this variable to a function of one argument of class REGISTRATION-CODE. It should send a registration code using template, suitable for your website.

Package: reblocks-auth/providers/email/models.
Source: file-type.lisp.

Special Variable: *user-class* ¶

Allows to redefine a model, for users to be created by the reblocks-auth.

Package: reblocks-auth/models.
Source: file-type.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

5.1.2 Macros

Macro: define-code-sender (name (from-email url-var &key subject) &body html-template-body) ¶

Package: reblocks-auth/providers/email/mailgun.
Source: file-type.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.3 Ordinary functions

Function: anonymous-p (user) ¶

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: change-email (user email) ¶

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: change-nickname (new-nickname) ¶

Changes nickname of the current user.

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: create-social-user (service service-user-id &rest metadata &key email) ¶

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: find-social-user (service service-user-id) ¶

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: get-all-users () ¶

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: get-current-user () ¶

Returns current user or NIL.

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: (setf get-current-user) () ¶

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: get-scopes () ¶

Returns current user’s scopes.

Package: reblocks-auth/github.
Source: file-type.lisp.

Function: get-token () ¶

Returns current user’s GitHub token.

Package: reblocks-auth/github.
Source: file-type.lisp.

Function: get-user-by-email (email) ¶

Returns a user with given email.

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: get-user-by-nickname (nickname) ¶

Returns a user with given email.

Package: reblocks-auth/models.
Source: file-type.lisp.

Function: make-login-processor () ¶

Package: reblocks-auth/core.
Source: file-type.lisp.

Function: make-logout-processor () ¶

Package: reblocks-auth/core.
Source: file-type.lisp.

Function: render-button (&key class scopes text retpath) ¶

Renders a button to request more scopes.

Package: reblocks-auth/github.
Source: file-type.lisp.

Function: render-buttons (&key retpath) ¶

Renders a row of buttons for enabled service providers.

Optionally you can specify RETPATH argument with an URI to return user after login.

Package: reblocks-auth/core.
Source: file-type.lisp.

Function: send-code (email &key retpath send-callback) ¶

Usually you should define a global callback using REBLOCKS-AUTH/PROVIDERS/EMAIL/MAILGUN:DEFINE-CODE-SENDER macro, but you can provide an alternative function to handle
email sending.

Package: reblocks-auth/providers/email/models.
Source: file-type.lisp.

Function: user-social-profiles (user) ¶

Returns a list of social profiles, bound to the user.

Package: reblocks-auth/models.
Source: file-type.lisp.

Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.4 Generic functions

Generic Function: authenticate (service &rest params &key code) ¶

Called when user had authenticated in the service and returned
to our site.

All GET arguments are collected into a plist and passed as params.

Should return two values a user and a flag denotifing if user was just created.

Package

reblocks-auth/auth.

Source

Methods

Method: authenticate ((service (eql :email)) &rest params &key code) ¶

Source: file-type.lisp.

Method: authenticate ((service (eql :github)) &rest params &key code) ¶

Source: file-type.lisp.

Method: authenticate (service &rest params) ¶

Generic Function: form-css-classes (widget) ¶

Package

Source

Methods

Method: form-css-classes ((widget request-code-form)) ¶

Generic Reader: get-email (object) ¶

Package

Methods

Reader Method: get-email ((user user)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: email.

Generic Reader: get-message (condition) ¶

Package

Methods

Reader Method: get-message ((condition unable-to-authenticate)) ¶

Source: file-type.lisp.
Target Slot: message.

Generic Reader: get-nickname (object) ¶

Package

Methods

Reader Method: get-nickname ((user user)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: nickname.

Generic Reader: get-reason (condition) ¶

Package

Methods

Reader Method: get-reason ((condition unable-to-authenticate)) ¶

Source: file-type.lisp.
Target Slot: reason.

Generic Reader: profile-metadata (object) ¶

Package

Methods

Reader Method: profile-metadata ((social-profile social-profile)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: metadata.

Generic Writer: (setf profile-metadata) (object) ¶

Package

Methods

Writer Method: (setf profile-metadata) ((social-profile social-profile)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: metadata.

Generic Reader: profile-service (object) ¶

Package

Methods

Reader Method: profile-service ((social-profile social-profile)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: service.

Generic Reader: profile-service-user-id (object) ¶

Package

Methods

Reader Method: profile-service-user-id ((social-profile social-profile)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: service-user-id.

Generic Reader: profile-user (object) ¶

Package

Methods

Reader Method: profile-user ((object social-profile)) ¶

Target Slot: user.

Generic Reader: registration-code (object) ¶

Package

Methods

Reader Method: registration-code ((registration-code registration-code)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: code.

Generic Reader: registration-email (object) ¶

Package

Methods

Reader Method: registration-email ((registration-code registration-code)) ¶

User’s email.

Source: file-type.lisp.
Target Slot: email.

Generic Function: render (service &key retpath) ¶

Renders a button for given service.
Service should be a keyword like :github or :facebook.

Package

reblocks-auth/button.

Source

Methods

Method: render ((service (eql :email)) &key retpath) ¶

Source: file-type.lisp.

Method: render ((service (eql :github)) &key retpath) ¶

Source: file-type.lisp.

Method: render (service &key retpath) ¶

Generic Function: render-email-input (widget) ¶

Package

Source

Methods

Method: render-email-input ((widget request-code-form)) ¶

Generic Function: render-login-page (app &key retpath) ¶

By default, renders a list of buttons for each allowed authentication method.

Package

Source

Methods

Method: render-login-page (app &key retpath) ¶

Generic Function: render-sent-message (widget) ¶

Package

Source

Methods

Method: render-sent-message ((widget request-code-form)) ¶

Method: render-sent-message ((widget request-code-form-for-popup)) ¶

Generic Function: render-submit-button (widget) ¶

Package

Source

Methods

Method: render-submit-button ((widget request-code-form)) ¶

Generic Reader: retpath (object) ¶

Package

Methods

Reader Method: retpath ((request-code-form request-code-form)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: retpath.

Generic Reader: sent (object) ¶

Package

Methods

Reader Method: sent ((request-code-form request-code-form)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: sent.

Generic Writer: (setf sent) (object) ¶

Package

Methods

Writer Method: (setf sent) ((request-code-form request-code-form)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: sent.

Generic Reader: valid-until (object) ¶

Package

Methods

Reader Method: valid-until ((registration-code registration-code)) ¶

Expiration time.

Source: file-type.lisp.
Target Slot: valid-until.

Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.5 Standalone methods

Method: get-dependencies ((widget request-code-popup)) ¶

Package: reblocks/dependencies.
Source: file-type.lisp.

Method: get-dependencies ((widget login-processor)) ¶

Package: reblocks/dependencies.
Source: file-type.lisp.

Method: print-object ((obj user) stream) ¶

Source: file-type.lisp.

Method: print-object ((obj social-profile) stream) ¶

Source: file-type.lisp.

Method: print-object ((obj registration-code) stream) ¶

Source: file-type.lisp.

Method: render ((widget request-code-form)) ¶

Package: reblocks/widget.
Source: file-type.lisp.

Method: render ((widget logout-processor)) ¶

Package: reblocks/widget.
Source: file-type.lisp.

Method: render ((widget login-processor)) ¶

Package: reblocks/widget.
Source: file-type.lisp.

Method: render-popup-content ((widget request-code-popup)) ¶

Package: reblocks-ui/popup.
Source: file-type.lisp.

Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.6 Conditions

Condition: nickname-is-not-available ¶

Signalled when there is already a user with given nickname.

Package: reblocks-auth/errors.
Source: file-type.lisp.
Direct superclasses: error.

Condition: unable-to-authenticate ¶

Package

Source

Direct superclasses

condition.

Direct methods

get-message.
get-reason.

Direct slots

Slot: message ¶

Initargs: :message
Readers: get-message.
Writers: This slot is read-only.

Slot: reason ¶

Initform: (quote nil)
Initargs: :reason
Readers: get-reason.
Writers: This slot is read-only.

Previous: Conditions, Up: Public Interface [Contents][Index]

5.1.7 Classes

Class: login-processor ¶

This widget should be rendered to process user’s login.

Package

Source

Direct superclasses

widget.

Direct methods

get-dependencies.
render.

Class: logout-processor ¶

This widget should be rendered to process user’s logout.

Package: reblocks-auth/core.
Source: file-type.lisp.
Direct superclasses: widget.
Direct methods: render.

Class: registration-code ¶

This model stores a code sent to an email for signup or log in.

Package

Source

Direct superclasses

dao-class.
record-timestamps-mixin.
serial-pk-mixin.

Direct methods

print-object.
registration-code.
registration-email.
valid-until.

Direct slots

Slot: email ¶

User’s email.

Initargs: :email
Readers: registration-email.
Writers: This slot is read-only.

Slot: code ¶

Initargs: :code
Readers: registration-code.
Writers: This slot is read-only.

Slot: valid-until ¶

Expiration time.

Initargs: :valid-until
Readers: valid-until.
Writers: This slot is read-only.

Class: request-code-form ¶

Package

Source

request-code-form-for-popup.

Direct superclasses

widget.

Direct subclasses

Direct methods

form-css-classes.
render.
render-email-input.
render-sent-message.
render-submit-button.
retpath.
(setf sent).
sent.

Direct slots

Slot: retpath ¶

Initargs: :retpath
Readers: retpath.
Writers: This slot is read-only.

Slot: sent ¶

Readers: sent.
Writers: (setf sent).

Class: social-profile ¶

Represents a User’s link to a social service.
User can be bound to multiple social services.

Package

Source

Direct superclasses

dao-class.
record-timestamps-mixin.
serial-pk-mixin.

Direct methods

print-object.
(setf profile-metadata).
profile-metadata.
profile-service.
profile-service-user-id.
profile-user.

Direct slots

Slot: user ¶

A USER instance, bound to the SOCIAL-PROFILE.

Initargs: :user
Readers: profile-user.
Writers: This slot is read-only.

Slot: user-id ¶

Initargs: :user-id

Slot: service ¶

Initargs: :service
Readers: profile-service.
Writers: This slot is read-only.

Slot: service-user-id ¶

Initargs: :service-user-id
Readers: profile-service-user-id.
Writers: This slot is read-only.

Slot: metadata ¶

Initargs: :metadata, :params
Readers: profile-metadata.
Writers: (setf profile-metadata).

Class: user ¶

This class stores basic information about user - it’s nickname and email. Additional information is stored inside SOCIAL-PROFILE instances.

Package

Source

Direct superclasses

dao-class.
record-timestamps-mixin.
serial-pk-mixin.

Direct methods

get-email.
get-nickname.
print-object.

Direct slots

Slot: nickname ¶

Initargs: :nickname
Readers: get-nickname.
Writers: This slot is read-only.

Slot: email ¶

Initargs: :email
Readers: get-email.
Writers: This slot is read-only.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Ordinary functions
Generic functions
Conditions
Classes

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *code-ttl* ¶

Time to live for authentication code.

Package: reblocks-auth/providers/email/models.
Source: file-type.lisp.

Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: check-registration-code (code) ¶

Authenticates a user.

If code wasn’t found, then condition code-unknown will be raised. If code is expired, then condition code-expired will be raised.

Возвращает пользователя, а вторым значением t если пользователь уже был и nil если это новая учётка.

Package: reblocks-auth/providers/email/models.
Source: file-type.lisp.

Function: get-oauth-token-by (code) ¶

Package: reblocks-auth/github.
Source: file-type.lisp.

Function: keywordify (string) ¶

Package: reblocks-auth/utils.
Source: file-type.lisp.

Function: make-authentication-url (&key scopes redirect-uri) ¶

Package: reblocks-auth/github.
Source: file-type.lisp.

Function: make-code-sender (thunk) ¶

Package: reblocks-auth/providers/email/mailgun.
Source: file-type.lisp.

Function: make-default-redirect-uri () ¶

Package: reblocks-auth/github.
Source: file-type.lisp.

Function: make-registration-code (email &key ttl) ¶

Package: reblocks-auth/providers/email/models.
Source: file-type.lisp.

Function: to-plist (alist &key without) ¶

Package: reblocks-auth/utils.
Source: file-type.lisp.

Function: verify-recaptcha (token) ¶

More about token verification:

https://developers.google.com/recaptcha/docs/verify

Package: reblocks-auth/providers/email/processing.
Source: file-type.lisp.

Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.3 Generic functions

Generic Reader: form (object) ¶

Package

Methods

Reader Method: form ((request-code-popup request-code-popup)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: form.

Generic Reader: get-code (condition) ¶

Package

Methods

Reader Method: get-code ((condition code-expired)) ¶

Source: file-type.lisp.
Target Slot: code.

Reader Method: get-code ((condition code-unknown)) ¶

Source: file-type.lisp.
Target Slot: code.

Generic Function: reach-goal (widget goal-name &key survive-redirect-p) ¶

Package

Source

Methods

Method: reach-goal (widget goal-name &key survive-redirect-p) ¶

Next: Classes, Previous: Generic functions, Up: Internals [Contents][Index]

5.2.4 Conditions

Condition: code-expired ¶

Signalled when code was found but already expired.

Package

Source

Direct superclasses

error.

Direct methods

get-code.

Direct slots

Slot: code ¶

Initargs: :code
Readers: get-code.
Writers: This slot is read-only.

Condition: code-unknown ¶

Signalled when code was not found in the database.

Package

Source

Direct superclasses

error.

Direct methods

get-code.

Direct slots

Slot: code ¶

Initargs: :code
Readers: get-code.
Writers: This slot is read-only.

Condition: new-accounts-are-prohibited ¶

Package: reblocks-auth/providers/email/processing.
Source: file-type.lisp.
Direct superclasses: error.

Previous: Conditions, Up: Internals [Contents][Index]

5.2.5 Classes

Class: request-code-form-for-popup ¶

Package: reblocks-auth/providers/email/processing.
Source: file-type.lisp.
Direct superclasses: request-code-form.
Direct methods: render-sent-message.

Class: request-code-popup ¶

Package

Source