README.md — CloudSecure WP Security 1.4.6

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

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

commands 8 months ago README.md 8 months ago class-cloudsecure-wp-cli-base.php 8 months ago class-cloudsecure-wp-cli.php 8 months ago

README.md

464 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
152	```
153
154	**設定�
155	目と設定可能な値:**
156
157	\| オプション \| 説明 \| 設定可能な値 \|
158	\|--------------------\|-----------------------------\|-----------------------------------------------------------\|
159	\| --enabled_roles \| 2段階認証が有効な権限グループ \| administrator, editor など(カンマ区切り、カスタム権限も含む) \|
160
161	**注意事�
162	:**
163	statusコマンドやenableコマンド実行時のレスポンスには、設定�
164	目に加えて`user_registrations`�
165	目も含まれます。この�
166	目には各ユーザーの2段階認証設定状況(1:設定済、0:未設定)が表示されます。
167
168	レスポンス例:
169	```json
170	{
171	"result": "success",
172	"data": {
173	"message": "2段階認証機能が有効になりました。",
174	"status": "enabled",
175	"configuration": {
176	"enabled_roles": "editor",
177	"user_registrations": "user1:0,user2:0,user3:1"
178	}
179	}
180	}
181	```
182
183
184	### captcha (画像認証追加)
185	```bash
186	wp cldsec-wp-security enable captcha --login=2 --comment=1 --lost_password=2 --register=2
187	```
188
189	**設定�
190	目と設定可能な値:**
191
192	\| オプション \| 説明 \| 設定可能な値 \|
193	\|--------------------\|----------------------------\|--------------------\|
194	\| --login \| ログインフォーム \| 1(無効), 2(有効) \|
195	\| --comment \| コメントフォーム \| 1(無効), 2(有効) \|
196	\| --lost_password \| パスワードリセットフォーム \| 1(無効), 2(有効) \|
197	\| --register \| ユーザー登録フォーム \| 1(無効), 2(有効) \|
198
199	### restrict-admin-page (管理画面アクセス制限)
200	```bash
201	wp cldsec-wp-security enable restrict-admin-page --paths="css,images,admin-ajax.php"
202	```
203
204	**設定�
205	目と設定可能な値:**
206
207	\| オプション \| 説明 \| 設定可能な値 \|
208	\|--------------\|-------------\|-----------------------------------------------\|
209	\| --paths \| 除外パス \| 例: css,images,admin-ajax.php(カンマ区切り) \|
210
211
212	### disable-access-system-file (設定ファイルアクセス防止)
213	```bash
214	wp cldsec-wp-security enable disable-access-system-file
215	```
216	**設定�
217	目と設定可能な値:**
218	設定�
219	目なし (有効/無効のみ)
220
221	### disable-author-query (ユーザー名漏えい防止)
222	```bash
223	wp cldsec-wp-security enable disable-author-query
224	```
225	**設定�
226	目と設定可能な値:**
227	設定�
228	目なし (有効/無効のみ)
229
230	### disable-xmlrpc (XML-RPC無効化)
231	```bash
232	wp cldsec-wp-security enable disable-xmlrpc --type=2
233	```
234
235	**設定�
236	目と設定可能な値:**
237
238	\| オプション \| 説明 \| 設定可能な値 \|
239	\|--------------\|--------------\|--------------------------------------\|
240	\| --type \| 無効化種別 \| 1(ピンバック無効), 2(XML-RPC無効) \|
241
242	レスポンス例:
243	```bash
244	# ピンバック無効の場合
245	wp cldsec-wp-security enable disable-xmlrpc --type=1
246	```
247	```json
248	{
249	"result": "success",
250	"data": {
251	"message": "ピンバック無効化機能が有効になりました。",
252	"status": "enabled",
253	"configuration": {
254	"type": "1"
255	}
256	}
257	}
258	```
259
260	```bash
261	# XML-RPC無効の場合
262	wp cldsec-wp-security enable disable-xmlrpc --type=2
263	```
264	```json
265	{
266	"result": "success",
267	"data": {
268	"message": "XML-RPC無効化機能が有効になりました。",
269	"status": "enabled",
270	"configuration": {
271	"type": "2"
272	}
273	}
274	}
275	```
276
277	### disable-restapi (REST API無効化)
278	```bash
279	wp cldsec-wp-security enable disable-restapi --exclude="wp/v2/users,wp/v2/posts"
280	```
281
282	**設定�
283	目と設定可能な値:**
284
285	\| オプション \| 説明 \| 設定可能な値 \|
286	\|--------------\|---------------\|--------------------------------------------------\|
287	\| --exclude \| 除外プラグイン \| 例: oembed,contact-form-7,akismet(カンマ区切り) \|
288
289
290	### waf (シンプルWAF)
291	```bash
292	wp cldsec-wp-security enable waf --available_rules="sql,xss,command" --send_admin_mail=2
293	```
294
295	**設定�
296	目と設定可能な値:** 設定�
297	目なし (有効/無効のみ)
298
299	\| オプション \| 説明 \| 設定可能な値 \|
300	\|----------------------\|-----------------\|-----------------------------------------------\|
301	\| --available_rules \| 検知する攻撃種別 \| sql, xss, command, code, mail(カンマ区切り) \|
302	\| --send_admin_mail \| メール通知 \| 1(通知しない), 2(通知する) \|
303
304
305	### login-notification (ログイン通知)
306	```bash
307	wp cldsec-wp-security enable login-notification --subject="ログイン通知" --body="ログインしました" --admin_only=1
308	```
309
310	**設定�
311	目と設定可能な値:**
312
313	\| オプション \| 説明 \| 設定可能な値 \|
314	\|-----------------\|-----------------\|-----------------------------------------\|
315	\| --subject \| サブジェクト \| 任意の文字列 \|
316	\| --body \| メール本文 \| 任意の文字列(改行は`__CLDSEC_NEWLINE__`) \|
317	\| --admin_only \| 受信�
318	\| 0(�
319	�員に通知), 1(管理�
320	のみ通知) \|
321
322
323	### update-notice (アップデート通知)
324	```bash
325	wp cldsec-wp-security enable update-notice --wp=1 --plugin=3 --theme=2
326	```
327
328	**設定�
329	目と設定可能な値:**
330
331	\| オプション \| 説明 \| 設定可能な値 \|
332	\|--------------\|-----------------------\|----------------------------------------------------------------------\|
333	\| --wp \| WordPressアップデート \| 1(通知しない), 2(通知する) \|
334	\| --plugin \| プラグインアップデート \| 1(通知しない), 2(すべて通知する), 3(有効化されたプラグインのみ通知する) \|
335	\| --theme \| テーマアップデート \| 1(通知しない), 2(すべて通知する), 3(有効化されたテーマのみ通知する) \|
336
337
338	### server-error-notification (サーバーエラー通知)
339	```bash
340	wp cldsec-wp-security enable server-error-notification --email_notification=1
341	```
342
343	**設定�
344	目と設定可能な値:**
345
346	\| オプション \| 説明 \| 設定可能な値 \|
347	\|------------------------\|------------------------\|-----------------------------\|
348	\| --email_notification \| メールで通知する \| 0(通知しない), 1(通知する) \|
349
350	## 特別なコマンド
351
352	### REST API無効化の専用操作
353
354	#### 有効プラグイン一覧の取得
355	```bash
356	wp cldsec-wp-security disable-restapi list-plugins
357	```
358
359	説明:
360	REST API無効化機能で除外指定していない有効なプラグインの一覧を取得します。
361
362	レスポンス例:
363	```json
364	{
365	"result": "success",
366	"data": {
367	"active_plugin_names": "plugin1,plugin2,plugin3"
368	}
369	}
370	```
371
372	## レスポンス形式
373
374	すべてのコマンドは統一されたJSON形式でレスポンスを返します：
375
376	成功時:
377	```json
378	{
379	"result": "success",
380	"data": { ... }
381	}
382	```
383
384	エラー時:
385	```json
386	{
387	"result": "error",
388	"data": {
389	"message": "エラーメッセージ"
390	}
391	}
392	```
393
394	## トラブルシューティング
395
396	### 設定�
397	目や値のエラーについて
398
399	間違った設定�
400	目名や設定値を指定した場合、エラーメッセージで利用可能な�
401	目や値が表示されます。
402
403	**存在しない設定�
404	目を指定した場合:**
405	```bash
406	wp cldsec-wp-security enable disable-login --test
407	```
408	```json
409	{
410	"result": "error",
411	"data": {
412	"message": "機能 'disable-login' には設定�
413	目 'test' は存在しません。利用可能な設定�
414	目: interval, limit, duration"
415	}
416	}
417	```
418
419	無効な設定値を指定した場合:
420	```bash
421	wp cldsec-wp-security enable disable-login --interval=100
422	```
423	```json
424	{
425	"result": "error",
426	"data": {
427	"message": "intervalは次のいずれかの値を指定してください: 5, 15, 30"
428	}
429	}
430	```
431
432	## 利用可能な機能一覧
433
434	\| 機能名 \| 説明 \| 設定�
435	目の有無 \|
436	\|--------\|------\|---------------\|
437	\| `disable-login` \| ログイン無効化 \| �
438	\|
439	\| `rename-login-page` \| ログインURL変更 \| �
440	\|
441	\| `unify-messages` \| ログインエラーメッセージ統一 \| ❌ \|
442	\| `two-factor-authentication` \| 2段階認証 \| �
443	\|
444	\| `captcha` \| 画像認証追加 \| �
445	\|
446	\| `restrict-admin-page` \| 管理画面アクセス制限 \| �
447	\|
448	\| `disable-access-system-file` \| 設定ファイルアクセス防止 \| ❌ \|
449	\| `disable-author-query` \| ユーザー名漏えい防止 \| ❌ \|
450	\| `disable-xmlrpc` \| XML-RPC無効化 \| �
451	\|
452	\| `disable-restapi` \| REST API無効化 \| �
453	\|
454	\| `waf` \| シンプルWAF \| �
455	\|
456	\| `login-notification` \| ログイン通知 \| �
457	\|
458	\| `update-notice` \| アップデート通知 \| �
459	\|
460	\| `server-error-notification` \| サーバーエラー通知 \| �
461	\|
462
463	注意: `login-log`(ログイン履歴)は設定値が存在しないため、status,enable,disableコマンドでは操作できません。
464