The Authenticators main task is to securely authenticate users for login to digital health applications. It authenticates authorized doctors or medical staff and grants them access to the respective application. This provides a secure authentication option for a variety of IT applications.
Visit our Fachportal-Page for more information.
See ReleaseNotes.md for all information regarding the (newest) releases.
You can find detailed documentation on the requirements, the installation and the preparation in our knowledge database: Documentation
Clone this repository and run npm install to install all necessary dependencies.
Then run npm run dev to start the Authenticator locally.
This repository contain the resources to set up the development environment for the authenticator app.
Clone the following repository at the same level of the authenticator repository:
git clone https://github.com/gematik/Vue-Oidcauth-Sample
Run npm run electron:build for the production build or npm run mock:build for the mock-version-build.
Within the mock-version of the Authenticator a mock mode is integrated, which can simulate the use of a connector. This allows functional tests to be carried out without a physically present connector. This feature is intended to simplify the development with the Authenticator, as it provides not only a special mock mode but also more logging options.
Visit our knowledge database for more information: Mock-Version
Run npm run test or npm run test:watch to start the unittests.
We use our own Webpack/Vue3 stack, to keep the App flexible and secure we do not use any framework like vue-cli or vue electron plugin. They have too many vulnerabilities and this is not acceptable in our case. Using the own webpack stack also brings us the real flexibility. We can change the configuration and the whole stack smoothly. This stack based on those technologies:
- Language: Typescript
- UI Framework: VueJS
- CSS Framework: TailwindCSS
- Bundler: Webpack
- JS Compiler: Babel
- Unit Testing: Jest
- Electron Compiler: Electron Builder
- Linter: ESLint
- Formatter: Prettier
For detailed documentation of usage of the Windows Credential Manager in the context of the Authenticator, see here
We 💖 contributions. You can find detailed information in CONTRIBUTING
Copyright 2021-2025 gematik GmbH
EUROPEAN UNION PUBLIC LICENCE v. 1.2
EUPL © the European Union 2007, 2016
See the LICENSE for the specific language governing permissions and limitations under the License
- 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.
- 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::
- The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.
- 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.
- 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.
- Gematik may remove published results temporarily or permanently from the place of publication at any time without prior notice or justification.
- 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.