The cl-recaptcha Reference Manual

This is the cl-recaptcha Reference Manual, version 2.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:25:07 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-recaptcha

Trivial support for the recaptcha service

Maintainer

Aad Versteden <>

Author

Aad Versteden <>

License

MIT

Version

2.0.0

Dependencies
  • drakma (system).
  • cl-ppcre (system).
  • flexi-streams (system).
  • jsown (system).
Source

cl-recaptcha.asd.

Child Component

code.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 cl-recaptcha/cl-recaptcha.asd

Source

cl-recaptcha.asd.

Parent Component

cl-recaptcha (system).

ASDF Systems

cl-recaptcha.

Packages

cl-recaptcha.sysdef.


3.1.2 cl-recaptcha/code.lisp

Source

cl-recaptcha.asd.

Parent Component

cl-recaptcha (system).

Packages

cl-recaptcha.

Public Interface
Internals

*captcha-verify-url* (special variable).


4 Packages

Packages are listed by definition order.


4.1 cl-recaptcha.sysdef

Source

cl-recaptcha.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 cl-recaptcha

Source

code.lisp.

Use List
  • common-lisp.
  • drakma.
  • flexi-streams.
  • jsown.
Public Interface
Internals

*captcha-verify-url* (special variable).


5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *recaptcha-header-script-tag*

The source of the javascript file, the standard value comes from recaptcha itself and should be available in any case

Package

cl-recaptcha.

Source

code.lisp.

Special Variable: *secret-key*

Secret key for the recaptcha service. This is mainly used server side to validate the challenge resopnse. Register at https://www.google.com/recaptcha/intro/index.html

Package

cl-recaptcha.

Source

code.lisp.

Special Variable: *site-key*

Site key for the recaptcha service. This is public facing and will appear in the div element that holds the recaptcha form. Register at https://www.google.com/recaptcha/intro/index.html

Package

cl-recaptcha.

Source

code.lisp.


5.1.2 Ordinary functions

Function: challenge-js (&key site-key theme callback expired-callback)

This is the javascript-enabled version of the challenge, recaptcha advises you to use this.

Package

cl-recaptcha.

Source

code.lisp.

Function: challenge-ns (&key site-key theme callback expired-callback)

This is the javascript-disabled version of the challenge. Google does not recommend it’s use if Javascript is a requirement for your site

Package

cl-recaptcha.

Source

code.lisp.

Function: verify-captcha (g-recaptcha-response &optional remote-ip &key secret-key)

Verifies the result the user gave. There are two values returned. The first indicates the success or failure, the second indicates the error code the captcha-server gave. Errors are returned in a list (just as the original JSON response returns errors in an array).

Package

cl-recaptcha.

Source

code.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *captcha-verify-url*

This is the URL that will be used to verify the result of the captcha. This is the one recaptcha provides

Package

cl-recaptcha.

Source

code.lisp.


Appendix A Indexes


A.1 Concepts