33 lines
774 B
Elixir
33 lines
774 B
Elixir
# Pleroma: A lightweight social networking server
|
|
# Copyright © 2017-2018 Pleroma Authors <https://pleroma.social/>
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
defmodule Pleroma.Captcha.Service do
|
|
@doc """
|
|
Request new captcha from a captcha service.
|
|
|
|
Returns:
|
|
|
|
Service-specific data for using the newly created captcha
|
|
"""
|
|
@callback new() :: map
|
|
|
|
@doc """
|
|
Validated the provided captcha solution.
|
|
|
|
Arguments:
|
|
* `token` the captcha is associated with
|
|
* `captcha` solution of the captcha to validate
|
|
|
|
Returns:
|
|
|
|
`true` if captcha is valid, `false` if not
|
|
"""
|
|
@callback validate(token :: String.t(), captcha :: String.t()) :: boolean
|
|
|
|
@doc """
|
|
This function is called periodically to clean up old captchas
|
|
"""
|
|
@callback cleanup() :: :ok
|
|
end
|