GakuNinmAPpublic

ページ ツリー

比較バージョン

古いバージョン 45

changes.mady.by.user Takeshi Nishimura

保存しました

次と比較

新しいバージョン 現在

changes.mady.by.user Soshi Urakami

保存しました

キー

  • この行は追加されました。
  • この行は削除されました。
  • 書式設定が変更されました。

目次


IdP管理者に必要な情報

学認参加IdPがクラウドゲートウェイを利用するために必要な情報をまとめます。学認参加IdPが学認クラウドゲートウェイサービスを利用するためには以下の手順に従って設定を行ってください。

注意

2017年2月22日(水)にentityIDが変更になりました。entityIDに https://map.gakunin.nii.ac.jp/shibboleth-sp が設定されている場合は https://cg.gakunin.jp/shibboleth-sp に変更してください。

まず、クラウドゲートウェイ (entityID: 学認クラウドゲートウェイサービス (entityID:  https://cg.gakunin.jp/shibboleth-sp ) に対して以下の属性を送信するようにしてください。

属性名必須 / 任意備考

ePPN (eduPersonPrincipalName)

必須


eduPersonTargetedID

任意


jao

任意

アカウント登録時のユーザ情報「所属（日）」の初期値として使われます。

o

任意

jaou
アカウント登録時のユーザ情報「所属（英）」の初期値として使われます。
任意

jaDisplayName

ou

任意

jaDisplayName
アカウント登録時のユーザ情報「氏名（日）」の初期値として使われます。

任意

displayName

任意

アカウント登録時のユーザ情報「氏名（英）」の初期値として使われます。

mail

任意

アカウント登録時のユーザ情報「メールアドレス」の初期値として使われます。
eduPersonAffiliation任意

ou/jaou/eduPersonTargetedID/eduPersonAffiliationを除いた任意の各属性は、GakuNin mAP上でのアカウント登録時にユーザ情報を初期入力するために使用されます。ユーザ情報の「所属」は日本語および英語がそれぞれjaoおよびoに対応します。ユーザ情報の「氏名」は日本語および英語がjaDisplayNameおよびdisplayNameに対応します。

また、o/jaoおよびou/jaouについては、機関グループもしくは部局グループを作成するのに利用可能です。詳しくは左記お問い合わせ先までお問い合わせください。（機能削除のためご利用いただけません）

eduPersonAffiliationは、faculty/staffであれば当該利用者が管理者となっているグループのメンバーに対する強制入会／属性送信同意強制のオプションが加わります。詳しくはお問い合わせください。


eduPersonAffiliationは、faculty/staffであれば当該利用者が管理者となっているグループのメンバーに対する招待なし入会・属性送信同意のオプションが加わります。詳しくはお問い合わせください。

学認クラウドゲートウェイサービスへの属性送信の設定例は以下を参照してください。設定例となっていますので、所属機関IdPで送信可能な属性へ変更してご利用ください。

コード ブロック
<!-- Policy for GakuNin Cloud Gateway Service -->
<AttributeFilterPolicy id="PolicyforGakuNinCloudGatewayService">
 
    <PolicyRequirementRule xsi:type="Requester" value="https://cg.gakunin.jp/shibboleth-sp" />
 
    <AttributeRule attributeID="eduPersonPrincipalName">
        <PermitValueRule xsi:type="ANY" />
    </AttributeRule>

    <AttributeRule attributeID="jao">
        <PermitValueRule xsi:type="ANY" />
    </AttributeRule>
 
    <AttributeRule attributeID="jaOrganizationName">
        <PermitValueRule xsi:type="ANY" />
    </AttributeRule>
 
    <AttributeRule attributeID="o">
        <PermitValueRule xsi:type="ANY" />
    </AttributeRule>

    <AttributeRule attributeID="organizationName">
        <PermitValueRule xsi:type="ANY" />
    </AttributeRule>

    <AttributeRule attributeID="jaDisplayName">
        <PermitValueRule xsi:type="ANY" />
    </AttributeRule>
 
    <AttributeRule attributeID="displayName">
        <PermitValueRule xsi:type="ANY" />
    </AttributeRule>
 
    <AttributeRule attributeID="mail">
        <PermitValueRule xsi:type="ANY" />
    </AttributeRule>
 
</AttributeFilterPolicy>
ヒント

本設定例は学認テンプレートv4およびv3両対応です。
お使いのattribute-resolver.xmlでの定義に応じて attributeID="jao" もしくは attributeID="jaOrganizationName" 、attributeID="o" もしくは attributeID="organizationName" の必要なほうを残してください。

そして、学認クラウドゲートウェイサービスと連携しているサービスそして、GakuNin mAPと連携しているサービス(SP)に対しても、必要な属性を送信していないとIdPの利用者は当該サービスが利用できませんのでご注意ください。


API

連携するIdPが利用できる、ゲートウェイトップ画面で表示される利用可能サービスの情報を取得するためのAPIを以下に示します。連携するIdPが利用できる、クラウドゲートウェイ画面で表示される利用可能サービスの情報を取得するためのAPIを以下に示します。
⇒API(IdP)

SP管理者に必要な情報

SP管理者が提供しているサービスをクラウドゲートウェイと連携させるためには以下の手順に従って設定を行ってください。SP管理者が提供しているサービスを学認クラウドゲートウェイサービスと連携させるためには以下の手順に従って設定を行ってください。

注意

以下の手順でisMemberOf属性を取得するためにはあらかじめIdPからeduPersonPrincipalName(ePPN)を取得していなければなりません。

 


  1. グループメンバー情報を取得できるようにする
    以下のようにShibboleth SPの設定ファイルを変更してください。動作確認は Shibboleth SP 2.6 で行っています。

    1. クラウドゲートウェイ 学認クラウドゲートウェイサービス (IdP)のメタデータを次のリンクから取得して /etc/shibboleth/metadata/ に保存してください。
      cgidp-metadata.xml

      警告

      2017年2月22日以前に設定されたかたは、アクセス先が変わっておりますので、最新のメタデータを用いてください。

      以前、Gakunin mAP連携のためにshibboleth2.xmlに以下の1行を追加している場合は 削除 してください。

      パネル

          <ProtocolProvider type="XML" validate="true" reloadChanges="false" path="protocols.xml"/>

          <TransportOption provider="CURL" option="81">0</TransportOption>
      </SPConfig>

      なお、メタデータ取得時のサーバ証明書検証（初期値ではいずれにしろ不完全です）については以下でご案内しておりますので、もし設定がまだのようであれば別途ご検討いただければと思います。
      shibboleth2.xml ファイル　の<TransportOption>の3行

    2. shibboleth2.xmlの編集
      /etc/shibboleth/shibboleth2.xml を編集します。

      • クラウドゲートウェイ 学認クラウドゲートウェイサービス (IdP)メタデータの読み込み
        a.でダウンロードしたメタデータを読み込むように設定します。他の<MetadataProvider>の後に下記を追加してください。

        コード ブロック
        xml
        xml
        <MetadataProvider type="XML" filepath="/etc/shibboleth/metadata/cgidp-metadata.xml"/>

      • SimpleAggregationの追加
        通常の認証フローの後にeppnを手がかりとしてクラウドゲートウェイ 通常の認証フローの後にeppnを手がかりとして学認クラウドゲートウェイサービス (IdP)からisMemberOf属性を取得するよう、SimpleAggregation設定を行います。
        既存の<AttributeResolver>の後に以下の記述を追加します。

        コード ブロック
        xml
        xml
        <AttributeResolver type="SimpleAggregation" attributeId="eppn" format="urn:oid:1.3.6.1.4.1.5923.1.1.1.6">
    <Entity> https<Entity>https://cg.gakunin.jp/idp/shibboleth <shibboleth</Entity>
    <saml2:Attribute xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" Name="urn:oid:1.3.6.1.4.1.5923.1.5.1.1" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="isMemberOf"/>
</AttributeResolver>

    3. attribute-map.xmlの編集
      /etc/shibboleth/attribute-map.xmlにisMemberOf属性の設定を行います。xmlにてisMemberOf属性の設定を確認します。
      最後の<以下の記述がない場合、最終行の</Attributes>の直前に、以下の記述を追加してください。Attributes>の直前に追加してください。

      <Attribute name="urn:mace:dir:attribute-def:isMemberOf
      " id="isMemberOf"/>
      コード ブロック
      xml
      xml
      <Attribute name="urn:oid:1.3.6.1.4.1.5923.1.5.1.1" id="isMemberOf"/>
      情報

      以前の版では以下の行も含めるように書いておりましたが、標準に準拠しておりませんのでこの記述は削除してください。

      コード ブロック
      xmlxml
    4. attribute-policy.xmlの編集
      他のIdPからのisMemberOf属性を拒否し、クラウドゲートウェイからのisMemberOfのみを利用する設定を行ないます。他のIdPからのisMemberOf属性を拒否し、学認クラウドゲートウェイサービスからのisMemberOfのみを利用する設定を行ないます。

      <!-- Catch-all that pases everything else through unmolested. -->

      の直前に以下の記述を追加してください。

      コード ブロック
      xml
      xml
      <afp:AttributeRule<AttributeRule attributeID="isMemberOf" xmlns="urn:mace:shibboleth:2.0:afp">
    <afp:PermitValueRule<PermitValueRule xsi:type="AttributeIssuerStringIssuer"
        value="https://cg.gakunin.jp/idp/shibboleth"/>
</afp:AttributeRule>

      .

  2. 取得したisMemberOf属性を利用するようにサービスを変更する
    例えば、isMemberOf属性には下記のような値が入ります。全てURI形式です。

    https://cg.gakunin.jp/sp/SPCID　←　SPコネクタ名
    https://cg.gakunin.jp/gr/GROUPID　←　ユーザが参加しているグループ名
    https://cg.gakunin.jp/gr/GROUPID/admin　←　ユーザが当該グループの管理者の場合

    後者2つは、SPコネクタの設定で「グループ情報も取得する」を選択した場合のみ取得できます。

    展開
    title旧形式への対応
    ヒント

    取得したisMemberOf属性のホスト部をチェックしているプラグインを使用している等で属性値が https://map.gakunin.nii.ac.jp/gr/... でないと支障がある場合は、shibboleth2.xmlに以下2箇所を追加してください。

    1. 既存の<ApplicationDefaults> より前に記述を追加。

      コード ブロック
           <OutOfProcess>
         <Extensions>
             <Library path="plugins.so" fatal="true"/>
         </Extensions>
     </OutOfProcess>

    2. 既存の<AttributeResolver> の後に記述を追加。

      コード ブロック
               <AttributeResolver type="Transform" source="isMemberOf">
             <Regex match="^https://cg.gakunin.jp/gr/(.+)$">https://map.gakunin.nii.ac.jp/gr/$1</Regex>
         </AttributeResolver>

  3. SPに対応するSPコネクタを作成する

    注意warning

    以下の機能はまだ実装されておりませんので、権限が必要な方はお手数ですが下記メールアドレスまでご一報ください。

    本項目の操作には適切に権限が付与されている必要があります。権限付与を希望する学認参加SPの運用担当者の方は学認クラウドゲートウェイサービスのページ下にある「問い合わせ先」（要ログイン）からサービスサポートまでご連絡ください。

    グループの接続先となるSPコネクタを作成します。グループが当該SPコネクタに接続した場合のみSPはそのグループに関する情報を取得できます。SPコネクタ作成の詳細は、mAP利用マニュアルの「あなたが学認申請システムでSP管理者として申請し、かつePPNを登録している場合はSPコネクタを作成する権限を与えられているはずです。そうでない場合は Image Removed までお問い合わせください。
    SPコネクタ作成の詳細は、mAP利用マニュアルの「SPコネクタを作成する」の章をご参照ください。
    .

API

連携するSPが利用できる、利用者のグループ情報等を取得するためのAPIを以下に示します。
⇒API

SP連携のトラブルシューティング

1. isMemberOf属性が取得できない

以下2つの条件を満たす場合にはisMemberOf属性が取得できません。

  • SP側の設定ファイルshibboleth2.

...

  • xmlのApplicationDefaultsに encryption="true"

...

  • と指定されている
  • ダウンロードしたメタデータcgidp-metadata.xmlの KeyDescriptor use="signing" （2か所）が設定されている （以前配布していたメタデータには use="signing" を設定していました）

上記でisMemberOf属性が取得できない原因はAttributeQueryのNameIDが暗号化されているためによるものですが、NameIDを暗号化したままisMemberOf属性を取得するためには、最新のメタデータcgidp-metadata.xmlをダウンロードし直すか（最新のメタデータでは use="signing" を削除済み）、以前ダウンロードしたメタデータの use="signing" （2か所）を削除してください。 の部分を削除（2か所）すれば、NameIDを暗号化したままでisMemberOfを取得できるようになります。