Skip to content

Documentation missing example in CAPTCHA section #966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 25, 2025
Merged

Documentation missing example in CAPTCHA section #966

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acb122b
Added missing example in CAPTCHA section
ch-rigu Mar 29, 2025
e1f2dd5
Merge branch 'master' into master
mdipierro May 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 145 additions & 0 deletions apps/_documentation/static/en/chapter-13.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,151 @@ <h4>OAuth2 with Discord<a class="headerlink" href="#oauth2-with-discord" title="
Discord username as the first name and discriminator as the last name.</p>
</div>
</section>
<hr>
<section id="captcha">
<h3>Authentication with CAPTCHA<a class="headerlink" href="#captcha" title="Link to this heading"></a></h3>

<p>CAPTCHAs are essential security measures that prevent automated bot abuse on public forms. To implement Google reCAPTCHA or hCAPTCHA in your authentication form, follow these steps:</p>

<section id="reCAPTCHA">
<h4>Enabling reCAPTCHA<a class="headerlink" href="#reCAPTCHA" title="Link to this heading"></a></h4>
<p>in <code class="docutils literal notranslate">settings.py</code> add your keys:</p>
<div class="highlight-python notranslate">
<div class="highlight">
<pre>
RECAPTCHA_API_SECRET_V3 = "your_recaptcha_secret_key_v3"
RECAPTCHA_API_KEY_V3 = "your_recaptcha_site_key_v3"

RECAPTCHA_API_KEY_V2 = "your_recaptcha_site_key_v2"
RECAPTCHA_API_SECRET_V2 = "your_recaptcha_secret_key_v2"

</pre>
</div>
</div>

<p>in <code class="docutils literal notranslate">common.py</code> add:</p>

<div class="highlight-python notranslate">
<div class="highlight">
<pre>
#import the functionality
<span class="kn">from</span> <span class="nn">. </span><span class="kn">import</span> settings
<span class="kn">from</span> <span class="nn">py4web.utils.recaptcha </span><span class="kn">import</span> ReCaptcha

# <span class="s2">for recaptcha v3</span>
<span class="nf">recaptcha</span> = <span class="nn">ReCaptcha</span>(<span class="nd">settings</span>.RECAPTCHA_API_KEY_V3, <span class="nd">settings</span>.RECAPTCHA_API_SECRET_V3, "v3")
or
# <span class="s2">for recaptcha v2</span>
<span class="nf">recaptcha</span> = <span class="nn">ReCaptcha</span>(<span class="nd">settings</span>.RECAPTCHA_API_KEY_V2, <span class="nd">settings</span>.RECAPTCHA_API_SECRET_V2, "v2")


# in the section that auth is defined
# Example:
auth = Auth(session, db, define_tables=False)

# Add this line at the end of auth declaration to enable recaptcha on login, register and request_reset_password forms.
# or enable it on the action that you want by especifying the action name

#Example:

auth.extra_form_fields = {"login": [<span class="nf">recaptcha</span>.field], "register": [<span class="nf">recaptcha</span>.field], "request_reset_password": [<span class="nf">recaptcha</span>.field], }


#In section where auth is enabled, add the recaptcha fixture
# Example:

# #######################################################
# Enable authentication
# #######################################################
auth.enable(uses=(session, T, db, <span class="nf">recaptcha</span>.fixture),env=dict(T=T))

</pre>

</div>

</div>
<p>in <code class="docutils literal notranslate">auth.html</code> use:</p>
<div class="highlight-python notranslate">
<div class="highlight">
<pre>
[[try:]]
[[=form]]
[[except:]]
[[pass]]
[[=recaptcha]]

</pre>
</div>
</div>
<p>
After completing these steps, the reCAPTCHA field will be added to the login, register, and request_reset_password forms.
</p>
</section>
<hr>
<section id="hCAPTCHA">
<h4>Enabling hCAPTCHA<a class="headerlink" href="#hCAPTCHA" title="Link to this heading"></a></h4>
<p>in <code class="docutils literal notranslate">settings.py</code> add your HCAPTCHA_SITE_KEY and HCAPTCHA_SECRET_KEY:</p>
<div class="highlight-python notranslate">
<div class="highlight">
<pre>
HCAPTCHA_SITE_KEY = "your_hcaptcha_site_key"
HCAPTCHA_SECRET_KEY = "your_hcaptcha_secret_key"
</pre>
</div>
</div>
<p>in <code class="docutils literal notranslate">common.py</code> add:</p>
<div class="highlight-python notranslate">
<div class="highlight">
<pre>
#import the functionality
<span class="kn">from</span> <span class="nn">. </span><span class="kn">import</span> settings
<span class="kn">from</span> <span class="nn">py4web.utils.hcaptcha </span><span class="kn">import</span> Hcaptcha

<span class="nf">hcaptcha</span> = <span class="nn">Hcaptcha</span>(<span class="nd">settings</span>.HCAPTCHA_SITE_KEY, <span class="nd">settings</span>.HCAPTCHA_SECRET_KEY)


# in the section that auth is defined
# Example:
auth = Auth(session, db, define_tables=False)

# Add this line at the end of auth declaration to enable hcaptcha on login, register and request_reset_password forms.
# or enable it on the action that you want by especifying the action name

#Example:

auth.extra_form_fields = {"login": [<span class="nf">hcaptcha</span>.field], "register": [<span class="nf">hcaptcha</span>.field], "request_reset_password": [<span class="nf">hcaptcha</span>.field], }


#In section where auth is enabled, add the hcaptcha fixture
# Example:

# #######################################################
# Enable authentication
# #######################################################
auth.enable(uses=(session, T, db, <span class="nf">hcaptcha</span>.fixture),env=dict(T=T))

</pre>

</div>

</div>
<p>in <code class="docutils literal notranslate">auth.html</code> use:</p>
<div class="highlight-python notranslate">
<div class="highlight">
<pre>
[[try:]]
[[=form]]
[[except:]]
[[pass]]
[[=hcaptcha]]

</pre>
</div>
</div>
<p>
After completing these steps, the hCAPTCHA field will be added to the login, register, and request_reset_password forms.
</p>
</section>
</section>
<section id="auth-api-plugins">
<h3>Auth API Plugins<a class="headerlink" href="#auth-api-plugins" title="Link to this heading"></a></h3>
Expand Down