自作プラグイン/recaptcha3.inc.php
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
検索
|
最終更新
|
ヘルプ
|
ログイン
]
開始行:
** recaptcha3.inc.php [#g81d06b9]
|RIGHT:100|LEFT:360|c
|~サマリ|Google reCAPTCHA v3 によるスパム対策|
|~リビジョン|1.0|
|~対応バージョン|1.5.3|
|~投稿者|[[M.Taniguchi]]|
|~投稿日|&new{2020-04-25 (土) 02:21:45};|
**概要 [#e3a7bff8]
Google reCAPTCHA v3 によるスパム対策プラグイン。
ページ編集・コメント投稿・ファイル添付など、PukiWiki標準...
reCAPTCHA v3 は不審な送信者を学習により自動判定する不可視...
追加ファイルはこのプラグインコードだけ。PukiWiki本体の変...
が、そのための副作用として、JavaScriptを活用する高度な編...
PukiWikiをほぼ素のままで運用し、手軽にスパム対策したいか...
PukiWiki 1.5.3／PHP 7.4／UTF-8／主要モダンブラウザーで動...
**導入手順 [#h76b3c6e]
以下の手順に沿ってPukiWikiに導入してください。
+本プラグイン recaptcha3.inc.php を plugin ディレクトリ...
+Google reCAPTCHA サイト（https: //www.google.com/recaptc...
+スキンファイル skin/pukiwiki.skin.php のほぼ末尾、「</bo...
<?php if (exist_plugin_convert('recaptcha3')) echo do_pl...
+ライブラリファイル lib/plugin.php の「function do_plugin...
if (exist_plugin_action('recaptcha3') && !call_user_func...
**コード [#h037a1e3]
recaptcha3.inc.php~
（下記のコードをコピーして、plugin ディレクトリに recaptc...
<?php
/**
PukiWiki - Yet another WikiWikiWeb clone.
recaptcha3.inc.php, v1.0 2020 M.Taniguchi
License: GPL v3 or (at your option) any later version
Google reCAPTCHA v3 によるスパム対策プラグイン。
ページ編集・コメント投稿・ファイル添付など、PukiWiki標準...
reCAPTCHA v3 は不審な送信者を学習により自動判定する不可...
追加ファイルはこのプラグインだけ。PukiWiki本体の変更も最...
が、そのための副作用として、JavaScriptを活用する高度な編...
PukiWikiをほぼ素のままで運用し、手軽にスパム対策したいか...
【導入手順】
以下の手順に沿ってPukiWikiに導入してください。
1) Google reCAPTCHA サイトでウィキのドメインを「reCAPTCH...
2) スキンファイル skin/pukiwiki.skin.php のほぼ末尾、「<...
<?php if (exist_plugin_convert('recaptcha3')) echo do...
3) ライブラリファイル lib/plugin.php の「function do_plu...
if (exist_plugin_action('recaptcha3') && !call_user_f...
【ご注意】
・PukiWiki 1.5.3／PHP 7.4／UTF-8／主要モダンブラウザーで...
・標準プラグイン以外の動作確認はしていません。サードパー...
・JavaScriptが有効でないと動作しません。
・サーバーからreCAPTCHA APIへのアクセスにcURLを使用しま...
・reCAPTCHA v3 について詳しくはGoogleのreCAPTCHAサイトを...
*/
define('PLUGIN_RECAPTCHA3_SITE_KEY', '取得したサイトキ...
define('PLUGIN_RECAPTCHA3_SECRET_KEY', '取得したシークレ...
define('PLUGIN_RECAPTCHA3_SCORE_THRESHOLD', 0.5); // ス...
define('PLUGIN_RECAPTCHA3_DISABLED', 0); // 本プラグイン...
define('PLUGIN_RECAPTCHA3_HIDE_BADGE', 1); // reCAPTCHA...
define('PLUGIN_RECAPTCHA3_API_TIMEOUT', 0); // reCAPTCHA...
// プラグイン出力
function plugin_recaptcha3_convert() {
// 本プラグインまたはJavaScriptが無効なら何もしない
if (PLUGIN_RECAPTCHA3_DISABLED || PKWK_READONLY || !PKW...
// 二重起動禁止
static $included = false;
if ($included) return '';
$included = true;
// reCAPTCHAバッジ非表示なら代替文言設定
$protocol = 'https:';
$badge = (!PLUGIN_RECAPTCHA3_HIDE_BADGE)? '' : '<style>...
// JavaScript
$siteKey = PLUGIN_RECAPTCHA3_SITE_KEY;
$apiUrl = $protocol . '//www.google.com/recaptcha/api.j...
$js = <<<EOT
<script src="${apiUrl}${siteKey}" defer></script>
<script>
window.addEventListener('load', function(){
new __PluginRecaptcha3__();
});
__PluginRecaptcha3__ = function() {
const self = this;
this.timer = null;
// 設定
this.update();
// DOMを監視し、もしページ内容が動的に変更されたら再設...
const observer = new MutationObserver(function(mutation...
if (observer) {
const target = document.getElementsByTagName('body')[0];
if (target) observer.observe(target, { childList: true...
}
};
// 設定
__PluginRecaptcha3__.prototype.setup = function() {
const self = this;
// 全form要素を走査
var elements = document.getElementsByTagName('form');
for (var i = elements.length - 1; i >= 0; --i) {
var form = elements[i];
// こちらのタイミングで送信するため、既定の送信イベン...
form.addEventListener('submit', self.stopSubmit, false);
// form内全submitボタンを走査しクリックイベントを設定
var eles = form.querySelectorAll('input[type="submit"]...
for (var j = eles.length - 1; j >= 0; --j) eles[j].add...
}
};
// 再設定
__PluginRecaptcha3__.prototype.update = function() {
const self = this;
if (this.timer) clearTimeout(this.timer);
this.timer = setTimeout(function() { self.setup(); self...
};
// 送信防止
__PluginRecaptcha3__.prototype.stopSubmit = function(e) {
e.preventDefault();
e.stopPropagation();
return false;
};
// クリック時送信処理
__PluginRecaptcha3__.prototype.submit = function(e) {
var form;
if (this.closest) {
form = this.closest('form');
} else {
for (form = this.parentNode; form; form = form.parentN...
}
// クリックされたsubmitボタンのname,value属性をhiddenに...
if (form) {
var nameEle = form.querySelector('.__plugin_recaptcha3...
var name = this.getAttribute('name');
if (name) {
var value = this.getAttribute('value');
if (!nameEle) {
form.insertAdjacentHTML('beforeend', '<input type="h...
} else {
nameEle.setAttribute('name', name);
nameEle.setAttribute('value', value);
}
} else
if (nameEle) {
if (nameEle.remove) nameEle.remove();
else nameEle.parentNode.removeChild(nameEle);
}
// reCAPTCHAトークン取得
grecaptcha.ready(function() {
try {
grecaptcha.execute('${siteKey}').then(function(token...
// 送信パラメーターにトークンを追加
var ele = form.querySelector('input[name="__plugin_...
if (!ele) {
form.insertAdjacentHTML('beforeend', '<input type=...
} else {
ele.setAttribute('value', token);
}
// フォーム送信
form.submit();
});
} catch(e) {}
});
}
return false;
};
</script>
EOT;
return $badge . $js;
}
// 受信リクエスト確認
function plugin_recaptcha3_action() {
$result = true; // 送信者判定結果（許可：true, 拒否：fa...
// 機能有効かつPOSTメソッド？
if (!PLUGIN_RECAPTCHA3_DISABLED && !PKWK_READONLY && $_...
/* 【対象プラグイン設定テーブル】
reCAPTCHA判定の対象とするプラグインを列挙する配列。
パターン1 … array('name' => プラグイン名)
パターン2 … array('name' => プラグイン名, 'vars' =>...
$targetPlugins = array(
array('name' => 'article'),
array('name' => 'attach'),
array('name' => 'bugtrack'),
array('name' => 'comment'),
array('name' => 'edit', 'vars' => 'write'), // editプ...
array('name' => 'insert'),
array('name' => 'loginform'),
array('name' => 'memo'),
array('name' => 'pcomment'),
array('name' => 'rename'),
array('name' => 'tracker'),
array('name' => 'vote'),
);
global $vars;
list($name) = func_get_args();
foreach ($targetPlugins as $target) {
if ($target['name'] != $name) continue; // プラグイン...
if (!isset($target['vars']) || isset($vars[$target['v...
if (!isset($vars['__plugin_recaptcha3__']) || $vars[...
// トークンのない不正要求なら送信者を拒否
$result = false;
} else {
// reCAPTCHA API呼び出し
$ch = curl_init('https:'.'//www.google.com/recaptch...
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_que...
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
if (PLUGIN_RECAPTCHA3_API_TIMEOUT > 0) curl_setopt(...
$data = json_decode(curl_exec($ch));
curl_close($ch);
// スコアが閾値未満なら送信者を拒否
if (!$data->success || $data->score < PLUGIN_RECAPT...
}
break;
}
}
}
return array('msg' => 'recaptcha3', 'body' => $result);
}
**ご注意 [#x8fb80a9]
-標準プラグイン以外の動作確認はしていません。サードパーテ...
-JavaScriptが有効でないと動作しません。
-サーバーからreCAPTCHA APIへのアクセスにcURLを使用します。
-reCAPTCHA v3 について詳しくはGoogleのreCAPTCHAサイトをご...
**詳細 [#pe9ff758]
***動作設定 [#ncf0cdef]
コード内の下記の定数で動作を制御することができます。
|~定数名|~値|~既定値|~意味|
|PLUGIN_RECAPTCHA3_SITE_KEY|CENTER:文字列||reCAPTCHA v3 ...
|PLUGIN_RECAPTCHA3_SECRET_KEY|CENTER:文字列||reCAPTCHA v3...
|PLUGIN_RECAPTCHA3_SCORE_THRESHOLD|CENTER:0.0～1.0|CENTER...
|PLUGIN_RECAPTCHA3_DISABLED|CENTER:0 or 1|CENTER:0|本プラ...
|PLUGIN_RECAPTCHA3_HIDE_BADGE|CENTER:0 or 1|CENTER:1|reCA...
|PLUGIN_RECAPTCHA3_API_TIMEOUT|CENTER:任意の数値|CENTER:0...
***スパム拒否の仕組み [#m18c40ac]
+ブラウザー側において、JavaScriptによってページ内のすべて...
+サーバー側において、受信したリクエストがPOSTメソッドかつ...
++パラメーターにreCAPTCHAトークンが含まれなければ、不正ア...
++reCAPTCHA APIにトークンを送信し、応答スコアが閾値未満な...
***高度な設定：対象プラグインの追加 [#k29ab2be]
本プラグインはデフォルトで、PukiWikiに標準添付の編集系プ...
article, attach, bugtrack, comment, edit, insert, loginfo...
スパムボットは標準プラグインを標的にすると考えられるため...
しかし、もし特定のサードパーティ製プラグインを標的として...
ただし上で述べた通り、プラグインの編集・投稿機能がPOSTメ...
**動作確認 [#mecf0290]
本プラグインが正しく導入されていれば、ページ末尾に「This ...
この状態でページ編集やコメント投稿ができていればＯＫです。
逆に拒否される場合を確認したければ、シークレットキーの値...
その状態でページ編集などを試みると、「Rejected by Google ...
スパムに対する正しいテストケースではありませんが、少なく...
実際のスパム攻撃については、Google reCAPTCHAサイトの管理...
なお、本プラグインが正しく導入されていても、古いブラウザ...
編集ができないだけで、閲覧には支障ないと思います。
閲覧専用（PKWK_READONLY が 1）のウィキにおいては、本プラ...
**ライセンス [#y9d827c1]
GPL v3
終了行:
** recaptcha3.inc.php [#g81d06b9]
|RIGHT:100|LEFT:360|c
|~サマリ|Google reCAPTCHA v3 によるスパム対策|
|~リビジョン|1.0|
|~対応バージョン|1.5.3|
|~投稿者|[[M.Taniguchi]]|
|~投稿日|&new{2020-04-25 (土) 02:21:45};|
**概要 [#e3a7bff8]
Google reCAPTCHA v3 によるスパム対策プラグイン。
ページ編集・コメント投稿・ファイル添付など、PukiWiki標準...
reCAPTCHA v3 は不審な送信者を学習により自動判定する不可視...
追加ファイルはこのプラグインコードだけ。PukiWiki本体の変...
が、そのための副作用として、JavaScriptを活用する高度な編...
PukiWikiをほぼ素のままで運用し、手軽にスパム対策したいか...
PukiWiki 1.5.3／PHP 7.4／UTF-8／主要モダンブラウザーで動...
**導入手順 [#h76b3c6e]
以下の手順に沿ってPukiWikiに導入してください。
+本プラグイン recaptcha3.inc.php を plugin ディレクトリ...
+Google reCAPTCHA サイト（https: //www.google.com/recaptc...
+スキンファイル skin/pukiwiki.skin.php のほぼ末尾、「</bo...
<?php if (exist_plugin_convert('recaptcha3')) echo do_pl...
+ライブラリファイル lib/plugin.php の「function do_plugin...
if (exist_plugin_action('recaptcha3') && !call_user_func...
**コード [#h037a1e3]
recaptcha3.inc.php~
（下記のコードをコピーして、plugin ディレクトリに recaptc...
<?php
/**
PukiWiki - Yet another WikiWikiWeb clone.
recaptcha3.inc.php, v1.0 2020 M.Taniguchi
License: GPL v3 or (at your option) any later version
Google reCAPTCHA v3 によるスパム対策プラグイン。
ページ編集・コメント投稿・ファイル添付など、PukiWiki標準...
reCAPTCHA v3 は不審な送信者を学習により自動判定する不可...
追加ファイルはこのプラグインだけ。PukiWiki本体の変更も最...
が、そのための副作用として、JavaScriptを活用する高度な編...
PukiWikiをほぼ素のままで運用し、手軽にスパム対策したいか...
【導入手順】
以下の手順に沿ってPukiWikiに導入してください。
1) Google reCAPTCHA サイトでウィキのドメインを「reCAPTCH...
2) スキンファイル skin/pukiwiki.skin.php のほぼ末尾、「<...
<?php if (exist_plugin_convert('recaptcha3')) echo do...
3) ライブラリファイル lib/plugin.php の「function do_plu...
if (exist_plugin_action('recaptcha3') && !call_user_f...
【ご注意】
・PukiWiki 1.5.3／PHP 7.4／UTF-8／主要モダンブラウザーで...
・標準プラグイン以外の動作確認はしていません。サードパー...
・JavaScriptが有効でないと動作しません。
・サーバーからreCAPTCHA APIへのアクセスにcURLを使用しま...
・reCAPTCHA v3 について詳しくはGoogleのreCAPTCHAサイトを...
*/
define('PLUGIN_RECAPTCHA3_SITE_KEY', '取得したサイトキ...
define('PLUGIN_RECAPTCHA3_SECRET_KEY', '取得したシークレ...
define('PLUGIN_RECAPTCHA3_SCORE_THRESHOLD', 0.5); // ス...
define('PLUGIN_RECAPTCHA3_DISABLED', 0); // 本プラグイン...
define('PLUGIN_RECAPTCHA3_HIDE_BADGE', 1); // reCAPTCHA...
define('PLUGIN_RECAPTCHA3_API_TIMEOUT', 0); // reCAPTCHA...
// プラグイン出力
function plugin_recaptcha3_convert() {
// 本プラグインまたはJavaScriptが無効なら何もしない
if (PLUGIN_RECAPTCHA3_DISABLED || PKWK_READONLY || !PKW...
// 二重起動禁止
static $included = false;
if ($included) return '';
$included = true;
// reCAPTCHAバッジ非表示なら代替文言設定
$protocol = 'https:';
$badge = (!PLUGIN_RECAPTCHA3_HIDE_BADGE)? '' : '<style>...
// JavaScript
$siteKey = PLUGIN_RECAPTCHA3_SITE_KEY;
$apiUrl = $protocol . '//www.google.com/recaptcha/api.j...
$js = <<<EOT
<script src="${apiUrl}${siteKey}" defer></script>
<script>
window.addEventListener('load', function(){
new __PluginRecaptcha3__();
});
__PluginRecaptcha3__ = function() {
const self = this;
this.timer = null;
// 設定
this.update();
// DOMを監視し、もしページ内容が動的に変更されたら再設...
const observer = new MutationObserver(function(mutation...
if (observer) {
const target = document.getElementsByTagName('body')[0];
if (target) observer.observe(target, { childList: true...
}
};
// 設定
__PluginRecaptcha3__.prototype.setup = function() {
const self = this;
// 全form要素を走査
var elements = document.getElementsByTagName('form');
for (var i = elements.length - 1; i >= 0; --i) {
var form = elements[i];
// こちらのタイミングで送信するため、既定の送信イベン...
form.addEventListener('submit', self.stopSubmit, false);
// form内全submitボタンを走査しクリックイベントを設定
var eles = form.querySelectorAll('input[type="submit"]...
for (var j = eles.length - 1; j >= 0; --j) eles[j].add...
}
};
// 再設定
__PluginRecaptcha3__.prototype.update = function() {
const self = this;
if (this.timer) clearTimeout(this.timer);
this.timer = setTimeout(function() { self.setup(); self...
};
// 送信防止
__PluginRecaptcha3__.prototype.stopSubmit = function(e) {
e.preventDefault();
e.stopPropagation();
return false;
};
// クリック時送信処理
__PluginRecaptcha3__.prototype.submit = function(e) {
var form;
if (this.closest) {
form = this.closest('form');
} else {
for (form = this.parentNode; form; form = form.parentN...
}
// クリックされたsubmitボタンのname,value属性をhiddenに...
if (form) {
var nameEle = form.querySelector('.__plugin_recaptcha3...
var name = this.getAttribute('name');
if (name) {
var value = this.getAttribute('value');
if (!nameEle) {
form.insertAdjacentHTML('beforeend', '<input type="h...
} else {
nameEle.setAttribute('name', name);
nameEle.setAttribute('value', value);
}
} else
if (nameEle) {
if (nameEle.remove) nameEle.remove();
else nameEle.parentNode.removeChild(nameEle);
}
// reCAPTCHAトークン取得
grecaptcha.ready(function() {
try {
grecaptcha.execute('${siteKey}').then(function(token...
// 送信パラメーターにトークンを追加
var ele = form.querySelector('input[name="__plugin_...
if (!ele) {
form.insertAdjacentHTML('beforeend', '<input type=...
} else {
ele.setAttribute('value', token);
}
// フォーム送信
form.submit();
});
} catch(e) {}
});
}
return false;
};
</script>
EOT;
return $badge . $js;
}
// 受信リクエスト確認
function plugin_recaptcha3_action() {
$result = true; // 送信者判定結果（許可：true, 拒否：fa...
// 機能有効かつPOSTメソッド？
if (!PLUGIN_RECAPTCHA3_DISABLED && !PKWK_READONLY && $_...
/* 【対象プラグイン設定テーブル】
reCAPTCHA判定の対象とするプラグインを列挙する配列。
パターン1 … array('name' => プラグイン名)
パターン2 … array('name' => プラグイン名, 'vars' =>...
$targetPlugins = array(
array('name' => 'article'),
array('name' => 'attach'),
array('name' => 'bugtrack'),
array('name' => 'comment'),
array('name' => 'edit', 'vars' => 'write'), // editプ...
array('name' => 'insert'),
array('name' => 'loginform'),
array('name' => 'memo'),
array('name' => 'pcomment'),
array('name' => 'rename'),
array('name' => 'tracker'),
array('name' => 'vote'),
);
global $vars;
list($name) = func_get_args();
foreach ($targetPlugins as $target) {
if ($target['name'] != $name) continue; // プラグイン...
if (!isset($target['vars']) || isset($vars[$target['v...
if (!isset($vars['__plugin_recaptcha3__']) || $vars[...
// トークンのない不正要求なら送信者を拒否
$result = false;
} else {
// reCAPTCHA API呼び出し
$ch = curl_init('https:'.'//www.google.com/recaptch...
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_que...
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
if (PLUGIN_RECAPTCHA3_API_TIMEOUT > 0) curl_setopt(...
$data = json_decode(curl_exec($ch));
curl_close($ch);
// スコアが閾値未満なら送信者を拒否
if (!$data->success || $data->score < PLUGIN_RECAPT...
}
break;
}
}
}
return array('msg' => 'recaptcha3', 'body' => $result);
}
**ご注意 [#x8fb80a9]
-標準プラグイン以外の動作確認はしていません。サードパーテ...
-JavaScriptが有効でないと動作しません。
-サーバーからreCAPTCHA APIへのアクセスにcURLを使用します。
-reCAPTCHA v3 について詳しくはGoogleのreCAPTCHAサイトをご...
**詳細 [#pe9ff758]
***動作設定 [#ncf0cdef]
コード内の下記の定数で動作を制御することができます。
|~定数名|~値|~既定値|~意味|
|PLUGIN_RECAPTCHA3_SITE_KEY|CENTER:文字列||reCAPTCHA v3 ...
|PLUGIN_RECAPTCHA3_SECRET_KEY|CENTER:文字列||reCAPTCHA v3...
|PLUGIN_RECAPTCHA3_SCORE_THRESHOLD|CENTER:0.0～1.0|CENTER...
|PLUGIN_RECAPTCHA3_DISABLED|CENTER:0 or 1|CENTER:0|本プラ...
|PLUGIN_RECAPTCHA3_HIDE_BADGE|CENTER:0 or 1|CENTER:1|reCA...
|PLUGIN_RECAPTCHA3_API_TIMEOUT|CENTER:任意の数値|CENTER:0...
***スパム拒否の仕組み [#m18c40ac]
+ブラウザー側において、JavaScriptによってページ内のすべて...
+サーバー側において、受信したリクエストがPOSTメソッドかつ...
++パラメーターにreCAPTCHAトークンが含まれなければ、不正ア...
++reCAPTCHA APIにトークンを送信し、応答スコアが閾値未満な...
***高度な設定：対象プラグインの追加 [#k29ab2be]
本プラグインはデフォルトで、PukiWikiに標準添付の編集系プ...
article, attach, bugtrack, comment, edit, insert, loginfo...
スパムボットは標準プラグインを標的にすると考えられるため...
しかし、もし特定のサードパーティ製プラグインを標的として...
ただし上で述べた通り、プラグインの編集・投稿機能がPOSTメ...
**動作確認 [#mecf0290]
本プラグインが正しく導入されていれば、ページ末尾に「This ...
この状態でページ編集やコメント投稿ができていればＯＫです。
逆に拒否される場合を確認したければ、シークレットキーの値...
その状態でページ編集などを試みると、「Rejected by Google ...
スパムに対する正しいテストケースではありませんが、少なく...
実際のスパム攻撃については、Google reCAPTCHAサイトの管理...
なお、本プラグインが正しく導入されていても、古いブラウザ...
編集ができないだけで、閲覧には支障ないと思います。
閲覧専用（PKWK_READONLY が 1）のウィキにおいては、本プラ...
**ライセンス [#y9d827c1]
GPL v3
ページ名:
![[PukiWiki-official]](image/pukiwiki-official.png "[PukiWiki-official]")
