Skip to content

Fix GakuNin group config #41

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
ryoya-hayase wants to merge 2 commits into
base: develop_v2.0.0
Choose a base branch
from
Open

Fix GakuNin group config #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1dec110
Fix GakuNin group config
ryoya-hayase Feb 26, 2026
dc72297
Merge pull request #106 from ryoya-hayase/fix/gakunin_config
ryoya-hayase Feb 26, 2026
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
28 changes: 14 additions & 14 deletions docs/operation/gakunin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,16 +527,16 @@ SPコネクタID_ロール識別子となる。
WEKO_ACCOUNTS_GAKUNIN_GROUP_PATTERN_DICT = {
"prefix":"jc",
"sysadm_group":"jc_roles_sysadm",
"role_keyword":"roles",
"role_keyword":"ro",
"role_mapping":{
"repoadm":"Repository Administrator",
"comadm":"Community Administrator",
"contributor":"Contributor",
"radm":"Repository Administrator",
"cadm":"Community Administrator",
"cont":"Contributor",
}
}
```

例えば、上記の場合、リポジトリ管理者のロール識別子は「repoadm」となる。
例えば、上記の場合、リポジトリ管理者のロール識別子は「radm」となる。
システム管理者のグループIDは「sysadm_group」で定義されている「jc_roles_sysadm」が利用される。

##### システム管理者グループを作成する（1度限り）
Expand Down Expand Up @@ -579,13 +579,13 @@ WEKO_ACCOUNTS_GAKUNIN_GROUP_PATTERN_DICT = {
|GakuNin mAP内で検索対象に|する|
|メンバー参加条件|管理者からの招待のみ参加できる|
|グループメンバーの公開・非公開|グループ入会者のみに公開|
|グループ名 必須|SPコネクタ名_roles_repoadm|
|グループID 必須|SPコネクタ名_roles_repoadm|
|グループ名 必須|SPコネクタ名_ro_radm|
|グループID 必須|SPコネクタ名_ro_radm|
|紹介文 必須|${FQDN}のリポジトリ管理者|

「作成」ボタンをクリックする。

グループ「SPコネクタ名_roles_repoadm」が作成される。
グループ「SPコネクタ名_ro_radm」が作成される。

###### コントリビュータグループを作成する。

Expand All @@ -595,13 +595,13 @@ WEKO_ACCOUNTS_GAKUNIN_GROUP_PATTERN_DICT = {
|GakuNin mAP内で検索対象に|する|
|メンバー参加条件|管理者からの招待のみ参加できる|
|グループメンバーの公開・非公開|グループ入会者のみに公開|
|グループ名 必須|SPコネクタ名_roles_contributor|
|グループID 必須|SPコネクタ名_roles_contributor|
|グループ名 必須|SPコネクタ名_ro_cont|
|グループID 必須|SPコネクタ名_ro_cont|
|紹介文 必須|${FQDN}のリポジトリ管理者|

「作成」ボタンをクリックする。

グループ「SPコネクタ名_roles_contributor」が作成される。
グループ「SPコネクタ名_ro_cont」が作成される。

#### SPコネクタへグループを追加する

Expand All @@ -614,7 +614,7 @@ WEKO_ACCOUNTS_GAKUNIN_GROUP_PATTERN_DICT = {

![グループ接続画面](pics/gakunin_test_image013.png)

先ほど作成したグループ「SPコネクタ名_roles_repoadm」「SPコネクタ名_roles_contributor」およびjc_roles_sysadmをSPコネクタに接続する。
先ほど作成したグループ「SPコネクタ名_ro_radm」「SPコネクタ名_ro_cont」およびjc_roles_sysadmをSPコネクタに接続する。

作成したグループメンバにシステム管理者を追加する。
（※トラブル対応目的）
Expand Down Expand Up @@ -713,7 +713,7 @@ GakuNin mAPのAPIを用いてグループ情報を取得し、Redisに保存す
|キー名| 説明|値例|
|---|---|---|
|updated_at|更新日時|2025-11-14T04:29:12+00:00|
|groups|カンマ区切りのグループ名|jc_roles_sysadm, jc_weko3_ir_rcos_nii_ac_jp_roles_contributor, jc_weko3_ir_rcos_nii_ac_jp_roles_repoadm|
|groups|カンマ区切りのグループ名|jc_roles_sysadm, jc_weko3_ir_rcos_nii_ac_jp_ro_cont, jc_weko3_ir_rcos_nii_ac_jp_ro_radm|

FQDNの「.」および「-」を「_」に置き換えた文字列+「_gakunin_groups」をキー名とする。

Expand All @@ -726,7 +726,7 @@ weko3_ir_rcos_nii_ac_jp_gakunin_groups
具体的なRedisへの設定方法は以下のとおりとなる。

```
HSET weko3_ir_rcos_nii_ac_jp_gakunin_groups updated_at "2025-11-14T04:29:12+00:00" groups "jc_roles_sysadm, jc_weko3_ir_rcos_nii_ac_jp_roles_contributor, jc_weko3_ir_rcos_nii_ac_jp_roles_repoadm"
HSET weko3_ir_rcos_nii_ac_jp_gakunin_groups updated_at "2025-11-14T04:29:12+00:00" groups "jc_roles_sysadm, jc_weko3_ir_rcos_nii_ac_jp_ro_cont, jc_weko3_ir_rcos_nii_ac_jp_ro_radm"
```

値の確認にはHGETを使う。
Expand Down
28 changes: 14 additions & 14 deletions docs/spec/base/other/SHIBBOLETH_01.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@

- 「jc\_roles\_sysadm」→ システム管理者ロール'System Administrator'

- 「jc\_\<entityid\>\_roles\_repoadm」→ リポジトリ管理者ロール'Repository Administrator'
- 「jc\_\<entityid\>\_ro\_radm」→ リポジトリ管理者ロール'Repository Administrator'

- 「jc\_\<entityid\>\_roles\_comadm」→ コミュニティ管理者ロール'Community Administrator'
- 「jc\_\<entityid\>\_ro\_cadm」→ コミュニティ管理者ロール'Community Administrator'

- 「jc\_\<entityid\>\_roles\_contributor」→ 一般利用者ロール'Contributor'
- 「jc\_\<entityid\>\_ro\_cont」→ 一般利用者ロール'Contributor'

2\. Shibboleth IdPからの属性情報に基づき、サイトライセンス機能を制御する

Expand Down Expand Up @@ -113,19 +113,19 @@
> WEKO_ACCOUNTS_GAKUNIN_GROUP_PATTERN_DICT = {
>     "prefix": "jc",                             # Prefix
>     "sysadm_group": "jc_roles_sysadm",         # システム管理者のグループ名
>     "role_keyword": "roles",                    # ロールグループを表すキーワード
>     "role_keyword": "ro",                     # ロールグループを表すキーワード
>     "role_mapping": {
>         "repoadm": "Repository Administrator",  # リポジトリ管理者グループ
>         "comadm": "Community Administrator",    # コミュニティ管理者グループ
>         "contributor": "Contributor"            # コントリビュータグループ
>         "radm": "Repository Administrator",   # リポジトリ管理者グループ
>         "cadm": "Community Administrator",   # コミュニティ管理者グループ
>         "cont": "Contributor"             # コントリビュータグループ
>     }
> }

- isMemberOf属性がない場合に付与する、IdP毎のデフォルトの学認mAPグループを設定する。

- IdPのエンティティIDをキーとして、デフォルトの学認mAPグループをリストで値に設定する。

- 例 {"abc\_idp\_ac\_jp": \["jc\_abc\_idp\_ac\_jp\_groups\_yyy"\] }
- 例 {"abc\_idp\_ac\_jp": \["jc\_abc\_idp\_ac\_jp\_gr\_yyy"\] }

- パス：<https://github.com/RCOSDP/weko/blob/v1.1.0/modules/weko-accounts/weko_accounts/config.py#L126>

Expand Down Expand Up @@ -275,11 +275,11 @@

- 「jc\_roles\_sysadm」→ システム管理者ロール'System Administrator'

- 「jc\_\<entityid\>\_roles\_repoadm」→ リポジトリ管理者ロール'Repository Administrator'
- 「jc\_\<entityid\>\_ro\_radm」→ リポジトリ管理者ロール'Repository Administrator'

- 「jc\_\<entityid\>\_roles\_comadm」→ コミュニティ管理者ロール'Community Administrator'
- 「jc\_\<entityid\>\_ro\_cadm」→ コミュニティ管理者ロール'Community Administrator'

- 「jc\_\<entityid\>\_roles\_contributor」→ 一般利用者ロール'Contributor'
- 「jc\_\<entityid\>\_ro\_cont」→ 一般利用者ロール'Contributor'

- ログインする

Expand All @@ -303,11 +303,11 @@

- 「jc\_roles\_sysadm」→ システム管理者ロール'System Administrator'

- 「jc\_\<entityid\>\_roles\_repoadm」→ リポジトリ管理者ロール'Repository Administrator'
- 「jc\_\<entityid\>\_ro\_radm」→ リポジトリ管理者ロール'Repository Administrator'

- 「jc\_\<entityid\>\_roles\_comadm」→ コミュニティ管理者ロール'Community Administrator'
- 「jc\_\<entityid\>\_ro\_cadm」→ コミュニティ管理者ロール'Community Administrator'

- 「jc\_\<entityid\>\_roles\_contributor」→ 一般利用者ロール'Contributor'
- 「jc\_\<entityid\>\_ro\_cont」→ 一般利用者ロール'Contributor'

- shibboleth\_userテーブルにレコードを作成する場合は、あわせてユーザ関連テーブルも上書きする

Expand Down