Skip to content

docs(ja): sync translations from 43d988b to 38ea7cb #3050

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

Open
wants to merge 1 commit into
base: release-5.10
Choose a base branch
from
Open

docs(ja): sync translations from 43d988b to 38ea7cb #3050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
169 changes: 128 additions & 41 deletions ja_JP/access-control/authz/mnesia.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# 組み込みデータベースの使用

EMQX は、組み込みデータベースを通じて低コストで即時に利用可能な認可ルールの保存方法を提供します。Dashboard または設定ファイルで組み込みデータベース（Mnesia）をデータソースとして設定し、Dashboard または HTTP API を通じて関連する認可チェックルールを追加できます。
EMQXは、組み込みデータベースを通じて低コストで即利用可能な認可ルールの保存方法を提供しています。Dashboardまたは設定ファイルで組み込みデータベース（Mnesia）をデータソースとして設定し、DashboardまたはHTTP APIを通じて関連する認可チェックルールを追加できます。

::: tip 前提条件

[EMQX 認可の基本概念](./authz.md)の知識
[EMQX認可の基本概念](./authz.md)の知識

:::

## Dashboard での設定
## Dashboardでの設定

1. [EMQX Dashboard](http://127.0.0.1:18083/#/authentication) の左側ナビゲーションツリーで **Access Control** -> **Authorization** をクリックし、**Authorization** ページに入ります。
1. [EMQX Dashboard](http://127.0.0.1:18083/#/authentication)の左側ナビゲーションツリーで **Access Control** -> **Authorization** をクリックし、**Authorization** ページに入ります。

2. 右上の **Create** をクリックし、**Backend** に **Built-in Database** を選択して **Next** をクリックします。

<img src="./assets/authz-mnesia_ee.png" alt="組み込みデータベース認可設定画面" style="zoom:40%;" />
<img src="./assets/authz-mnesia_ee.png" alt="authz-mnesia_ee" style="zoom:40%;" />

3. 組み込みデータベース認可は設定パラメータを必要としないため、**Create** をクリックして完了します。
3. 組み込みデータベースの認可は設定パラメータを必要としないため、**Create** をクリックして完了します。

## 設定ファイルでの設定

組み込みデータベースの認可機能は、`type` が `built_in_database` で識別されます。
組み込みデータベースの認可チェッカーは、`type` に `built_in_database` を指定して識別されます。

設定例：

Expand All @@ -33,54 +33,141 @@ EMQX は、組み込みデータベースを通じて低コストで即時に利

- `type`: 認可チェッカーのデータソースタイプ。ここでは `built_in_database` を指定します。

- `enable`: このチェッカーを有効にするかどうか。オプション値は `true` または `false`。
- `enable`: このチェッカーを有効にするかどうか。オプション値は `true`、`false`。

<!--詳細なパラメータ一覧は [authz-mnesia](../../configuration/configuration-manual.html#authz-mnesia) を参照してください。-->
<!--詳細なパラメータ一覧は[authz-mnesia](../../configuration/configuration-manual.html#authz-mnesia)を参照してください。-->

## 認可ルールの作成

認可ルールは Dashboard または API を通じて作成できます。
認可ルールはDashboardまたはAPIを通じて作成できます。

### Dashboard での作成
### Dashboardでの作成

Dashboard の **Authorization** ページで、**Built-in Database** バックエンドの **Actions** 列にある **Permissions** ボタンをクリックします。
Dashboardの **Authorization** ページで、**Built-in Database** バックエンドの **Actions** 列にある **Permissions** ボタンをクリックします。

<img src="./assets/authz-config-built-in-rules_ee.png" alt="組み込みデータベース認可ルール設定画面" style="zoom:50%;" />
<img src="./assets/authz-config-built-in-rules_ee.png" alt="authz-config-built-in-rules_ee" style="zoom:50%;" />

クライアント ID、ユーザー名、またはトピックに基づいて認可チェックを設定できます。
クライアントID、ユーザー名、またはトピックに基づいて認可チェックを設定できます。

- **Client ID**: **Client ID** タブで、このルールを適用するクライアントを指定します。
- **Username**: **Username** タブで、このルールを適用するユーザーを指定します。
- **Permission**: 現在のクライアント／ユーザーからの特定の操作リクエストを許可するか拒否するか。オプション値は **Allow** または **Deny**。
- **Permission**: 現在のクライアント／ユーザーからの特定の操作リクエストを許可するか拒否するか。オプション値は **Allow**、**Deny**。
- **Action**: このルールに対応する操作を設定。オプション値は **Publish**、**Subscribe**、**Publish & Subscribe**。
- **Topic**: このルールに対応するトピックを設定。

EMQX は単一のクライアントまたはユーザーに対して複数の認可チェックルールを設定可能で、ページ上の **Move Up** と **Move Down** ボタンで異なるルールの実行順序や優先度を調整できます。
EMQXは単一のクライアントまたはユーザーに対して複数の認可チェックルールを設定可能であり、ページ上の **Move Up** および **Move Down** ボタンでルールの実行順序と優先度を調整できます。

複数のクライアントやユーザーに対して同時に認可チェックルールを設定したい場合は、HTTP API を通じて関連設定をインポートできます。
複数のクライアントまたはユーザーに対して同時に認可チェックルールを設定したい場合は、HTTP APIを通じて関連設定をインポートできます。

### API での作成
### APIでの作成

ルールは `/api/v5/authorization/sources/built_in_database` API で管理します。
ルールは `/api/v5/authorization/sources/built_in_database` APIで管理されます。

各ルールは以下に適用されます：
* clientid で識別される特定のクライアント
* `/api/v5/authorization/sources/built_in_database/clientid`
* username で識別される特定のクライアント
* `/api/v5/authorization/sources/built_in_database/username`
* 全クライアント
* `/api/v5/authorization/sources/built_in_database/all`
Built-in Databaseバックエンドの認可ルールをAPIで管理する手順は以下の通りです。

以下はクライアント (`client1`) に対するルール作成の簡単な例です：
#### ステップ1: 認証トークンの取得

EMQX Dashboardに認証し、APIアクセス用のトークンを取得します。

```bash
export EMQX_TOKEN=$(curl --silent -X 'POST' "http://localhost:18083/api/v5/login" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{"username": "admin","password": "public"}' | jq -r ".token")
```

#### ステップ2: 組み込みデータベース認可ソースの作成

```bash
curl -X 'POST' \
'http://localhost:18083/api/v5/authorization/sources/built_in_database/clientid' \
-H 'accept: */*' \
'http://localhost:18083/api/v5/authorization/sources' \
-H "Authorization: Bearer $EMQX_TOKEN" \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-d '[
{
"clientid": "client1",
-d '{
"enable": true,
"max_rules": 100,
"type": "built_in_database"
}'
```

#### ステップ3: 認可ルールの作成

以下のようにルールを作成できます。

- **クライアントIDによる特定クライアント向け**:

```bash
curl -X 'POST' \
'http://localhost:18083/api/v5/authorization/sources/built_in_database/rules/clients' \
-H "Authorization: Bearer $EMQX_TOKEN" \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-d '[
{
"clientid": "client1",
"rules": [
{
"action": "publish",
"permission": "allow",
"topic": "test/topic/1"
},
{
"action": "subscribe",
"permission": "allow",
"topic": "test/topic/2"
},
{
"action": "all",
"permission": "deny",
"topic": "eq test/#"
}
]
}
]'
```

- **ユーザー名による特定ユーザー向け**:

```bash
curl -X 'POST' \
'http://localhost:18083/api/v5/authorization/sources/built_in_database/rules/users' \
-H "Authorization: Bearer $EMQX_TOKEN" \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-d '[
{
"username": "user1",
"rules": [
{
"action": "publish",
"permission": "allow",
"topic": "test/topic/1"
},
{
"action": "subscribe",
"permission": "allow",
"topic": "test/topic/2"
},
{
"action": "all",
"permission": "deny",
"topic": "eq test/#"
}
]
}
]'
```

- **全クライアント共通**:

```bash
curl -X 'POST' \
'http://localhost:18083/api/v5/authorization/sources/built_in_database/rules/all' \
-H "Authorization: Bearer $EMQX_TOKEN" \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"rules": [
{
"action": "publish",
Expand All @@ -98,13 +185,13 @@ curl -X 'POST' \
"topic": "eq test/#"
}
]
}
]'
```
}'
```

各ルールには以下が含まれます。

各ルールは以下を含みます：
* `permission`: 現在のクライアント／ユーザーからの特定の操作リクエストを許可するか拒否するか。オプション値は `allow` または `deny`。
* `action`: このルールに対応する操作。オプション値は `publish`、`subscribe`、または `all`。
* `topic`: このルールに対応するトピック。 [トピックプレースホルダー](./authz.md#topic-placeholders) をサポートします。
* `qos`: （オプション）ルールが適用される QoS レベルを指定する数値配列。例：`[0, 1]`、`[1, 2]`。デフォルトはすべての QoS レベル。
* `retain`: （オプション）現在のルールがリテインメッセージをサポートするかどうか。値は `true` または `false`。デフォルトはリテインメッセージを許可。
- `permission`: 操作を許可するか拒否するか。値は `allow` または `deny`。
- `action`: 操作タイプ。値は `publish`、`subscribe`、または `all`。
- `topic`: トピックフィルター。[トピックプレースホルダー](./authz.md#topic-placeholders)をサポート。
- `qos`: *(オプション)* このルールが適用されるQoSレベルの配列（例: `[0, 1]`）。指定しない場合はすべてのQoSレベルに適用。
- `retain`: *(オプション)* 保持メッセージにルールを適用するかどうか。値は `true` または `false`。デフォルトは保持メッセージを許可。
Loading
Loading