{"id":18985555,"url":"https://github.com/gematik/ref-idp-server","last_synced_at":"2026-03-16T12:09:43.125Z","repository":{"id":52184172,"uuid":"322221240","full_name":"gematik/ref-idp-server","owner":"gematik","description":"Der Gematik IDP-Server dient zur Identifizierung von Versicherten und Leistungserbringenden Organisationen.","archived":false,"fork":false,"pushed_at":"2025-04-15T13:40:35.000Z","size":30435,"stargazers_count":24,"open_issues_count":1,"forks_count":5,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-15T14:26:35.569Z","etag":null,"topics":["idm","other","reference-implementation"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gematik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-17T07:54:10.000Z","updated_at":"2025-04-15T13:40:16.000Z","dependencies_parsed_at":"2024-11-08T16:34:25.946Z","dependency_job_id":"2e85a814-9523-4066-b43e-4eb481d9a7f7","html_url":"https://github.com/gematik/ref-idp-server","commit_stats":null,"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gematik%2Fref-idp-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gematik%2Fref-idp-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gematik%2Fref-idp-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gematik%2Fref-idp-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gematik","download_url":"https://codeload.github.com/gematik/ref-idp-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249250819,"owners_count":21237961,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["idm","other","reference-implementation"],"created_at":"2024-11-08T16:27:11.950Z","updated_at":"2026-03-16T12:09:43.116Z","avatar_url":"https://github.com/gematik.png","language":"Java","readme":"## Disclaimer\n\nThis software is not developed for productive use. It was developed to check the feasibility of the\nspecification.\n\n## Overview\n\nThe **IDP-Global** project consists of various sub-projects. These are\n\n* **IDP-Server:** Reference development of the central IDP\n* **IDP-Client:** Client to request ACCESS_TOKEN with SMC-B-Aut or HBA-Aut keys\n  at the central IDP\n* **IDP-Testsuite:** Approval test suite for a central IDP, also includes tests for Fast Track\n  and federated IDPs\n\n### Idp-Server as docker image\n\n#### Use existing image from docker hub\n\nhttps://hub.docker.com/r/gematik1/idp-server\n\n#### Build image of Idp-Server, 2 examples\n\nin project root:\n\n###### Example 1: build with all tests\n\n```console \n$ mvn clean install -pl idp-server -am\n```\n\n###### Example 2: build without unit/int tests, set parameter commit_hash for dockerfile\n\n```console \n$ mvn clean install -pl idp-server -am -Dskip.unittests -Dskip.inttests -Dcommit_hash=`git log --pretty=format:'%H' -n 1`\n```\n\n#### Start container\n\n```console \n$ docker run --rm -it -p 8571:8080 gematik1/idp-server\n```\n\nor use docker compose:\n\n```console\n$ mvn clean install -pl idp-server -am -Dskip.unittests -Dskip.inttests -Dskip.dockerbuild=false\n$ export appVersion=\u003c...\u003e # e.g. 29.1.6\n$ docker-compose --project-name myidp -f docker-compose-ref.yml up -d\n```\n\n#### Smoke test: get discovery document\n\n```console \n$ curl http://localhost:8571/auth/realms/idp/.well-known/openid-configuration\n```\n\n### Scope Configuration via application.yaml\n\nYou can modify the scopes that are supported by the IDP Server. All you have to is add, remove or\nmodify entries in the scopesConfiguration section of the idp-server's application.yml.\n\n### Configuration of Server URL\n\nThe URL of the idp-server is required for many fields inside the discovery document of the server.\nFor example, the\nauthorization endpoint:\n\n```\n{\n\"authorization_endpoint\": \"https://server42/sign_response\",\n...\n```\n\nThe idp-server determines the URL in the following priority order if it exists:\n\n1. jvm arg: --idp.serverUrl=https://myServerUrlAsJvmArgument.de\n2. environment variable: IDP_SERVER_URL=myServerUrlFromEnv:8080\n3. spring boot configuration (application.yml):\n\n```\nidp:\n   serverUrl: \"https://urlPreConfiguredUrl\"\n```\n\nDuring development, it is recommended to set \"severUrl\" not in application.yml as some unit tests\nwill fail then.\nBackground: serverUrl will be set several times in the discovery document and used from there in\nunit tests.\nIn unit tests, random (free) ports are used, and with that they are part of the serverUrl.\n\n4. precompiled value: IdpConstants.DEFAULT_SERVER_URL\n\n### idp-server logging\n\nLogs are written via log4j2 to console.\n\nExport `LOG_LEVEL_GEMATIK=\u003cYOUR LOG LEVEL\u003e` to set the log level.\nExport REQUEST_LOGGING_ENABLED=true to enable request logging.\nSee also [idp-server application.yml](idp-server/src/main/resources/application.yml) for\nconfiguration.\n\n### Unittests\n\ndisable: `-Dskip.unittests`\n\nAll keys and p12 containers inside this repository were intentionally published. They allow the\nproject to be built ootb after a clean checkout and run the testsuite.\n\n### Integration Testing/Approval Testing\n\ndisable: `-Dskip.inttests`\n\nTests of the Idp-Testsuite are integration tests as well.\u003cbr\u003e\nBased on integration tests, approval tests are poosible. Please refer to\n[README im submodule idp-testsuite](idp-testsuite/README.md).\n\n## Caveats\n\nCall all build targets always from project root (\"idp-global\").\n\n## Tokenflow sites\n\n* [TokenFlow EGK](https://gematik.github.io/ref-idp-server/tokenFlowEgk.html)\n* [TokenFlow PS](https://gematik.github.io/ref-idp-server/tokenFlowPs.html)\n* [TokenFlow SSO](https://gematik.github.io/ref-idp-server/tokenFlowSso.html)\n\n## Swagger\n\nfind generated API at: /swagger-ui/index.html\n\n## License\n\nCopyright 2020-2026 gematik GmbH\n\nApache License, Version 2.0\n\nSee the [LICENSE](./LICENSE) for the specific language governing permissions and limitations under the License\n\n## Additional Notes and Disclaimer from gematik GmbH\n\n1. Copyright notice: Each published work result is accompanied by an explicit statement of the license conditions for use. These are regularly typical conditions in connection with open source or free software. Programs described/provided/linked here are free software, unless otherwise stated.\n2. Permission notice: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n    1. The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.\n    2. The software is provided \"as is\" without warranty of any kind, either express or implied, including, but not limited to, the warranties of fitness for a particular purpose, merchantability, and/or non-infringement. The authors or copyright holders shall not be liable in any manner whatsoever for any damages or other claims arising from, out of or in connection with the software or the use or other dealings with the software, whether in an action of contract, tort, or otherwise.\n    3. The software is the result of research and development activities, therefore not necessarily quality assured and without the character of a liable product. For this reason, gematik does not provide any support or other user assistance (unless otherwise stated in individual cases and without justification of a legal obligation). Furthermore, there is no claim to further development and adaptation of the results to a more current state of the art.\n3. Gematik may remove published results temporarily or permanently from the place of publication at any time without prior notice or justification.\n4. Please note: Parts of this code may have been generated using AI-supported technology. Please take this into account, especially when troubleshooting, for security analyses and possible adjustments.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgematik%2Fref-idp-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgematik%2Fref-idp-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgematik%2Fref-idp-server/lists"}