README.md — CloudSecure WP Security trunk

cloudsecure-wp-security / modules / cli / README.md

cloudsecure-wp-security / modules / cli Last commit date

commands 9 hours ago README.md 9 hours ago class-cloudsecure-wp-cli-base.php 2 months ago class-cloudsecure-wp-cli.php 9 months ago

README.md

468 lines

1	# CloudSecure WP Security CLI Commands
2
3	このドキュメントでは、CloudSecure WP Security プラグインのWP-CLIコマンドの使用方法について説明します。
4
5	## インストール
6
7	プラグインが有効化されていれば、自動的にWP-CLIコマンドが利用可能になります。
8
9	## 基本コマンド
10
11	### 利用可能な機能一覧を表示
12
13	```bash
14	wp cldsec-wp-security list
15	```
16
17	レスポンス形式:
18	```json
19	{
20	"result": "success",
21	"data": [
22	{
23	"name": "disable-login",
24	"description": "ログイン無効化",
25	"status": "enabled"
26	},
27	]
28	}
29	```
30
31	### 特定機能の詳細状�
32	�を確認
33
34	```bash
35	wp cldsec-wp-security status <機能名>
36	```
37
38	例:
39	```bash
40	wp cldsec-wp-security status disable-login
41	```
42
43	レスポンス形式:
44	```json
45	{
46	"result": "success",
47	"data": {
48	"name": "disable-login",
49	"description": "ログイン無効化",
50	"status": "enabled",
51	"configuration": {
52	"interval": "5",
53	"limit": "5",
54	"duration": "300"
55	}
56	}
57	}
58	```
59
60	**注意事�
61	:**
62	- 機能名は�
63	須です (単一の機能名のみ受付、複数指定はエラー)
64	- `--option=value` 形式のオプション引数は渡されても使用しません
65
66	### 機能の有効化
67
68	```bash
69	wp cldsec-wp-security enable <機能名> [--設定�
70	目=値]
71	```
72
73	例:
74	```bash
75	wp cldsec-wp-security enable disable-login --interval=5 --limit=5 --duration=300
76	```
77
78	**注意事�
79	:**
80	- 機能名は�
81	須です(単一の機能名のみ受付、複数指定はエラー)
82
83	### 機能の無効化
84
85	```bash
86	wp cldsec-wp-security disable <機能名>
87	```
88
89	例:
90	```bash
91	wp cldsec-wp-security disable disable-login
92	```
93
94	レスポンス例:
95	```json
96	{
97	"result": "success",
98	"message": "ログイン無効化機能が無効になりました。"
99	}
100	```
101
102	**注意事�
103	:**
104	- 機能名は�
105	須です(単一の機能名のみ受付、複数指定はエラー)
106	- `--option=value` 形式のオプション引数は渡されても使用しません
107
108	## 利用可能な機能と設定�
109	目
110
111	### disable-login (ログイン無効化)
112	```bash
113	wp cldsec-wp-security enable disable-login --interval=5 --limit=5 --duration=300
114	```
115
116	**設定�
117	目と設定可能な値:**
118
119	\| オプション \| 説明 \| 設定可能な値 \|
120	\|----------------\|----------------------\|----------------------------\|
121	\| --interval \| 間隔(秒) \| 5, 15, 30 \|
122	\| --limit \| ログイン失敗回数 \| 5, 15, 30 \|
123	\| --duration \| ログイン無効時間(秒) \| 60, 180, 300, 600, 3600 \|
124
125
126	### rename-login-page (ログインURL変更)
127	```bash
128	wp cldsec-wp-security enable rename-login-page --name=custom-login --disable_redirect=0
129	```
130
131	**設定�
132	目と設定可能な値:**
133
134	\| オプション \| 説明 \| 設定可能な値 \|
135	\|----------------------\|-----------------------\|--------------------------------\|
136	\| --name \| 変更後のログインURL \| 4-12文字、英小文字・数字・-・_ \|
137	\| --disable_redirect \| リダイレクト設定 \| 0(リダイレクトする), 1(しない) \|
138
139
140	### unify-messages (ログインエラーメッセージ統一)
141	```bash
142	wp cldsec-wp-security enable unify-messages
143	```
144	**設定�
145	目と設定可能な値:**
146	設定�
147	目なし (有効/無効のみ)
148
149	### two-factor-authentication (2段階認証)
150	```bash
151	wp cldsec-wp-security enable two-factor-authentication --enabled_roles=administrator,editor --xmlrpc_login=1
152	```
153
154	**設定�
155	目と設定可能な値:**
156
157	\| オプション \| 説明 \| 設定可能な値 \|
158	\|--------------------\|----------------------------------\|-----------------------------------------------------------\|
159	\| --enabled_roles \| 2段階認証が有効な権限グループ \| administrator, editor など(カンマ区切り、カスタム権限も含む) \|
160	\| --xmlrpc_login \| XML-RPC経由のログイン制限 \| 0(許可), 1(拒否) \|
161
162	**注意事�
163	:**
164	- `xmlrpc_login` のデフォルト値は `1`（拒否）です。2段階認証が有効な権限グループのユーザーに対して、XML-RPC経由のログインをすべて拒否します。
165	- statusコマンドやenableコマンド実行時のレスポンスには、設定�
166	目に加えて`user_registrations`�
167	目も含まれます。この�
168	目には各ユーザーの2段階認証設定状況(1:設定済、0:未設定)が表示されます。
169
170	レスポンス例:
171	```json
172	{
173	"result": "success",
174	"data": {
175	"message": "2段階認証機能が有効になりました。",
176	"status": "enabled",
177	"configuration": {
178	"xmlrpc_login": "1",
179	"enabled_roles": "editor",
180	"user_registrations": "user1:0,user2:0,user3:1"
181	}
182	}
183	}
184	```
185
186
187	### captcha (画像認証追加)
188	```bash
189	wp cldsec-wp-security enable captcha --login=2 --comment=1 --lost_password=2 --register=2
190	```
191
192	**設定�
193	目と設定可能な値:**
194
195	\| オプション \| 説明 \| 設定可能な値 \|
196	\|--------------------\|----------------------------\|--------------------\|
197	\| --login \| ログインフォーム \| 1(無効), 2(有効) \|
198	\| --comment \| コメントフォーム \| 1(無効), 2(有効) \|
199	\| --lost_password \| パスワードリセットフォーム \| 1(無効), 2(有効) \|
200	\| --register \| ユーザー登録フォーム \| 1(無効), 2(有効) \|
201
202	### restrict-admin-page (管理画面アクセス制限)
203	```bash
204	wp cldsec-wp-security enable restrict-admin-page --paths="css,images,admin-ajax.php"
205	```
206
207	**設定�
208	目と設定可能な値:**
209
210	\| オプション \| 説明 \| 設定可能な値 \|
211	\|--------------\|-------------\|-----------------------------------------------\|
212	\| --paths \| 除外パス \| 例: css,images,admin-ajax.php(カンマ区切り) \|
213
214
215	### disable-access-system-file (設定ファイルアクセス防止)
216	```bash
217	wp cldsec-wp-security enable disable-access-system-file
218	```
219	**設定�
220	目と設定可能な値:**
221	設定�
222	目なし (有効/無効のみ)
223
224	### disable-author-query (ユーザー名漏えい防止)
225	```bash
226	wp cldsec-wp-security enable disable-author-query
227	```
228	**設定�
229	目と設定可能な値:**
230	設定�
231	目なし (有効/無効のみ)
232
233	### disable-xmlrpc (XML-RPC無効化)
234	```bash
235	wp cldsec-wp-security enable disable-xmlrpc --type=2
236	```
237
238	**設定�
239	目と設定可能な値:**
240
241	\| オプション \| 説明 \| 設定可能な値 \|
242	\|--------------\|--------------\|--------------------------------------\|
243	\| --type \| 無効化種別 \| 1(ピンバック無効), 2(XML-RPC無効) \|
244
245	レスポンス例:
246	```bash
247	# ピンバック無効の場合
248	wp cldsec-wp-security enable disable-xmlrpc --type=1
249	```
250	```json
251	{
252	"result": "success",
253	"data": {
254	"message": "ピンバック無効化機能が有効になりました。",
255	"status": "enabled",
256	"configuration": {
257	"type": "1"
258	}
259	}
260	}
261	```
262
263	```bash
264	# XML-RPC無効の場合
265	wp cldsec-wp-security enable disable-xmlrpc --type=2
266	```
267	```json
268	{
269	"result": "success",
270	"data": {
271	"message": "XML-RPC無効化機能が有効になりました。",
272	"status": "enabled",
273	"configuration": {
274	"type": "2"
275	}
276	}
277	}
278	```
279
280	### disable-restapi (REST API無効化)
281	```bash
282	wp cldsec-wp-security enable disable-restapi --exclude="wp/v2/users,wp/v2/posts"
283	```
284
285	**設定�
286	目と設定可能な値:**
287
288	\| オプション \| 説明 \| 設定可能な値 \|
289	\|--------------\|---------------\|--------------------------------------------------\|
290	\| --exclude \| 除外プラグイン \| 例: oembed,contact-form-7,akismet(カンマ区切り) \|
291
292
293	### waf (シンプルWAF)
294	```bash
295	wp cldsec-wp-security enable waf --available_rules="sql,xss,command" --send_admin_mail=2 --backtrack_error=1
296	```
297
298	**設定�
299	目と設定可能な値:**
300
301	\| オプション \| 説明 \| 設定可能な値 \|
302	\|----------------------\|--------------------------\|-----------------------------------------------\|
303	\| --available_rules \| 検知する攻撃種別 \| sql, xss, command, code, mail(カンマ区切り) \|
304	\| --send_admin_mail \| メール通知 \| 1(通知しない), 2(通知する) \|
305	\| --backtrack_error \| 検査上限�
306	過時の遮断設定 \| 0(遮断しない), 1(遮断する) \|
307
308
309	### login-notification (ログイン通知)
310	```bash
311	wp cldsec-wp-security enable login-notification --subject="ログイン通知" --body="ログインしました" --admin_only=1
312	```
313
314	**設定�
315	目と設定可能な値:**
316
317	\| オプション \| 説明 \| 設定可能な値 \|
318	\|-----------------\|-----------------\|-----------------------------------------\|
319	\| --subject \| サブジェクト \| 任意の文字列 \|
320	\| --body \| メール本文 \| 任意の文字列(改行は`__CLDSEC_NEWLINE__`) \|
321	\| --admin_only \| 受信�
322	\| 0(�
323	�員に通知), 1(管理�
324	のみ通知) \|
325
326
327	### update-notice (アップデート通知)
328	```bash
329	wp cldsec-wp-security enable update-notice --wp=1 --plugin=3 --theme=2
330	```
331
332	**設定�
333	目と設定可能な値:**
334
335	\| オプション \| 説明 \| 設定可能な値 \|
336	\|--------------\|-----------------------\|----------------------------------------------------------------------\|
337	\| --wp \| WordPressアップデート \| 1(通知しない), 2(通知する) \|
338	\| --plugin \| プラグインアップデート \| 1(通知しない), 2(すべて通知する), 3(有効化されたプラグインのみ通知する) \|
339	\| --theme \| テーマアップデート \| 1(通知しない), 2(すべて通知する), 3(有効化されたテーマのみ通知する) \|
340
341
342	### server-error-notification (サーバーエラー通知)
343	```bash
344	wp cldsec-wp-security enable server-error-notification --email_notification=1
345	```
346
347	**設定�
348	目と設定可能な値:**
349
350	\| オプション \| 説明 \| 設定可能な値 \|
351	\|------------------------\|------------------------\|-----------------------------\|
352	\| --email_notification \| メールで通知する \| 0(通知しない), 1(通知する) \|
353
354	## 特別なコマンド
355
356	### REST API無効化の専用操作
357
358	#### 有効プラグイン一覧の取得
359	```bash
360	wp cldsec-wp-security disable-restapi list-plugins
361	```
362
363	説明:
364	REST API無効化機能で除外指定していない有効なプラグインの一覧を取得します。
365
366	レスポンス例:
367	```json
368	{
369	"result": "success",
370	"data": {
371	"active_plugin_names": "plugin1,plugin2,plugin3"
372	}
373	}
374	```
375
376	## レスポンス形式
377
378	すべてのコマンドは統一されたJSON形式でレスポンスを返します：
379
380	成功時:
381	```json
382	{
383	"result": "success",
384	"data": { ... }
385	}
386	```
387
388	エラー時:
389	```json
390	{
391	"result": "error",
392	"data": {
393	"message": "エラーメッセージ"
394	}
395	}
396	```
397
398	## トラブルシューティング
399
400	### 設定�
401	目や値のエラーについて
402
403	間違った設定�
404	目名や設定値を指定した場合、エラーメッセージで利用可能な�
405	目や値が表示されます。
406
407	**存在しない設定�
408	目を指定した場合:**
409	```bash
410	wp cldsec-wp-security enable disable-login --test
411	```
412	```json
413	{
414	"result": "error",
415	"data": {
416	"message": "機能 'disable-login' には設定�
417	目 'test' は存在しません。利用可能な設定�
418	目: interval, limit, duration"
419	}
420	}
421	```
422
423	無効な設定値を指定した場合:
424	```bash
425	wp cldsec-wp-security enable disable-login --interval=100
426	```
427	```json
428	{
429	"result": "error",
430	"data": {
431	"message": "intervalは次のいずれかの値を指定してください: 5, 15, 30"
432	}
433	}
434	```
435
436	## 利用可能な機能一覧
437
438	\| 機能名 \| 説明 \| 設定�
439	目の有無 \|
440	\|--------\|------\|---------------\|
441	\| `disable-login` \| ログイン無効化 \| �
442	\|
443	\| `rename-login-page` \| ログインURL変更 \| �
444	\|
445	\| `unify-messages` \| ログインエラーメッセージ統一 \| ❌ \|
446	\| `two-factor-authentication` \| 2段階認証 \| �
447	\|
448	\| `captcha` \| 画像認証追加 \| �
449	\|
450	\| `restrict-admin-page` \| 管理画面アクセス制限 \| �
451	\|
452	\| `disable-access-system-file` \| 設定ファイルアクセス防止 \| ❌ \|
453	\| `disable-author-query` \| ユーザー名漏えい防止 \| ❌ \|
454	\| `disable-xmlrpc` \| XML-RPC無効化 \| �
455	\|
456	\| `disable-restapi` \| REST API無効化 \| �
457	\|
458	\| `waf` \| シンプルWAF \| �
459	\|
460	\| `login-notification` \| ログイン通知 \| �
461	\|
462	\| `update-notice` \| アップデート通知 \| �
463	\|
464	\| `server-error-notification` \| サーバーエラー通知 \| �
465	\|
466
467	注意: `login-log`(ログイン履歴)は設定値が存在しないため、status,enable,disableコマンドでは操作できません。
468