Skip to content

Metadata sources for all service providers in the CLARIN Service Provider Federation

Notifications You must be signed in to change notification settings

hzsk/SPF-SPs-metadata

 
 

Repository files navigation

Metadata sources for service providers inside the CLARIN Service Provider Federation

Notes for service provider operators

To update or add SAML metadata for your SP:

  1. Fork this repository.
  2. Make your changes to the clarin-sp-metadata.xml file.
  3. Create a pull request to the master branch of this repository.
  4. Wait for Travis CI to finish the XSD validation on your pull request.
  5. Make sure your pull request is XSD valid. Fix your code based on the Travis CI output information and update the pull request until XSD validation passes.
  6. Wait for your pull request to be merged into the master branch by a CLARIN SPF operator. This will trigger the generation of a QA report by Travis CI.
  7. Wait for Travis CI to finish the generation of the QA report.
  8. Fix the issues concerning your SP described in the QA report and update your pull request accordingly (alternatively you can also submit a new pull request with your QA fixes).

After a pull request is created (3.) the SAML metadata checker script will automactically run on the pull request code via Travis CI (4.). The result of this check will be visible on the pull request page. Check the existing pull resquests on this repository for examples.

When your pull request successfully passes XSD validation (5.), a CLARIN SPF operator will merge it into the master branch of original repository for QA assessment (6.). Note: the SPF operators will only consider for merging pull requests which are XSD valid. If you cannot make your file successfully pass the XSD validation or you believe you are hitting a false positive. Please create an ​issue explaining the problem.

After your pull request is merged (6.), Travis CI will automatically analyze the latest master version and generate a QA report visible in ​this table (7.). Please ascertain that you comply with ​the SAML metadata guidelines. Mind to check and resolve issues in the SAML metadata quality for your SP after your pull request has been merged into the master branch, then update your pull request with any necessary fixes or create a new one (8.). Make sure you always update the SAML metadata template of your SP to make it correspond exactly with the SAML metadata you deposit here (see e.g. ​https://goo.gl/uysudA).

If you wish that the registration/modification of the SAML metadata about your SP with identity federations is coordinated extra carefully (say, you perform a key rollover), then please create a new ​issue describing the task. Alternatively you can also head over to https://trac.clarin.eu/newticket and create a ticket for the 'AAI' Trac component (requires a CLARIN 'developer' account).

Finally your metadata will be merged into the production branch and picked up by an hourly cron job which automatically checks out the latest version and publishes it at ​https://infra.clarin.eu/aai/md_about_spf_sps.xml (staging feed) and https://infra.clarin.eu/aai/prod_md_about_spf_sps.xml (production feed).

Note: For an SP to be published in the production feed it must be defined first as a production SP in our configuration. This can only be done by CLARIN SPF operators.

About

Metadata sources for all service providers in the CLARIN Service Provider Federation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%