English
Installation
Windows
Start the installer of AusweisApp using the command line to configure the installation process and preset system-wide default settings. The return value of msiexec indicates the result of the installation [1]. In addition to the usual arguments [2], the following command contains all supported arguments, which are explained below.
msiexec /i AusweisApp-X.YY.Z.msi /quiet INSTALLDIR="C:\AusweisApp" SYSTEMSETTINGS=false DESKTOPSHORTCUT=false PROXYSERVICE=false AUTOSTART=false AUTOHIDE=false REMINDTOCLOSE=false ASSISTANT=false TRANSPORTPINREMINDER=false CUSTOMPROXYTYPE="HTTP" CUSTOMPROXYHOST="proxy.example.org" CUSTOMPROXYPORT=1337 UPDATECHECK=false ONSCREENKEYBOARD=true SHUFFLESCREENKEYBOARD=true SECURESCREENKEYBOARD=true ENABLECANALLOWED=true SKIPRIGHTSONCANALLOWED=true LAUNCH=true
- INSTALLDIR
States the installation directory. If not specified, the folder „C:\Program Files\AusweisApp“ is used.
- SYSTEMSETTINGS
Concerns the settings of firewall rules of the Windows Firewall. When not specifying the argument, firewall rules are created (true). By indicating SYSTEMSETTINGS=false, no firewall rules are created.
- DESKTOPSHORTCUT
By specifying DESKTOPSHORTCUT=false, no desktop shortcut is created. Without specifying the argument, the desktop shortcut is created for all users (true).
- PROXYSERVICE
The proxy service is required to enable the parallel operation of several entities of AusweisApp. The proxy service monitors port 24727 (defined in BSI TR-03124-1) and forwards requests to the local AusweisApp instances. The Discovery messages (amendment to BSI TR-03112-6 - IFD Service - Chapter 3) are not forwarded, so that SaC devices cannot be recognized or used in this operating mode. Not specified, the proxy service will be installed automatically if Terminal Services is installed and the system is running in application server mode.
- AUTOSTART
Setting AUTOSTART=true creates autostart entry for all users. Users are unable to deactivate the autostart function in the AusweisApp. Not specified, no autostart entry is created (false). In that case, users are able to activate the autostart function in the AusweisApp.
- AUTOHIDE
Concerns the automatic minimization after a successful authentication. Not specified, it is activated (true). Setting AUTOHIDE=false, it is deactivated. Users can adjust this setting to their preferences.
- REMINDTOCLOSE
Closing the AusweisApp by clicking on the X, the user is notified that only the user interface is closed and that the AusweisApp is still available in the info tray. At this point, it is possible to prevent future notifications. Setting REMINDTOCLOSE=false deactivates this notification from the outset. Not specified, it is activated (true).
- ASSISTANT
Starting the AusweisApp for the first time, the user interface is displayed and the installation wizard is shown. With each subsequent start, the AusweisApp is started in the background, without the installation wizard being shown. By indicating ASSISTANT=false, the AusweisApp is started in the background without the installation wizard from the outset. Not specified, the installation wizard is activated (true).
- TRANSPORTPINREMINDER
Prior to the first authentication, the user is asked once whether they have changed their Transport PIN. Setting TRANSPORTPINREMINDER=false deactivates this reminder. Not specified, the reminder is activated (true).
- CUSTOMPROXYTYPE
Part of a proxy configuration. Valid values are SOCKS5 and HTTP. All proxy parameters have to be set to use the proxy (see CUSTOMPROXYHOST and CUSTOMPROXYPORT). You can disable the proxy after installation with a checkbox in the settings.
- CUSTOMPROXYHOST
Part of a proxy configuration. Sets the Host of the proxy. All proxy parameters have to be set to use the proxy (see CUSTOMPROXYTYPE and CUSTOMPROXYPORT). You can disable the proxy after installation with a checkbox in the settings.
- CUSTOMPROXYPORT
Part of a proxy configuration. Sets the port of the proxy. Only values between 1 and 65536 are valid. All proxy parameters have to be set to use the proxy (see CUSTOMPROXYTYPE and CUSTOMPROXYHOST). You can disable the proxy after installation with a checkbox in the settings.
- UPDATECHECK
Upon opening the user interface of the AusweisApp, an update check is started, provided that at least 24 hours have elapsed since the last update check. If a newer version is available, the user is notified accordingly. Setting UPDATECHECK to false or true deactivates or activates the update check respectively. Users are unable to change this setting in the AusweisApp. Not specified, the update check is activated, but users can adjust the settings. The UPDATECHECK parameter affects neither updates of the service provider list nor updates of card reader information.
- ONSCREENKEYBOARD
An on-screen keyboard is available to enter PIN, CAN or PUK. It is deactivated or activated by setting ONSCREENKEYBOARD to false or true. Users are able to adjust the setting.
- SHUFFLESCREENKEYBOARD
If the on-screen keyboard is activated, the number keys can be arranged at random. By setting SHUFFLESCREENKEYBOARD to false or true, the random arrangement can be deactivated or activated. Users are able to adjust the setting.
- SECURESCREENKEYBOARD
If the on-screen keyboard is activated, the animation of the number keys can be disabled. By setting SECURESCREENKEYBOARD to false or true, the animation can be activated or deactivated. Users are able to adjust the setting.
- ENABLECANALLOWED
Enables support for the CAN allowed mode. If the provider got issued a corresponding authorization certificate the ID card can be read by entering the CAN instead of the PIN.
- SKIPRIGHTSONCANALLOWED
Skips the page with the authorization certificate in the CAN allowed mode and asks directly for the CAN.
- LAUNCH
Starts the AusweisApp after the installation has finished.
Alternatively, Orca [3] can be used to create an MST file that defines the above arguments. The arguments are available in the „Directory“ and „Property“ tables. The MST file can be transferred with the following command:
msiexec /i AusweisApp-X.YY.Z.msi /quiet TRANSFORMS=file.mst
In order to optimize the start of the AusweisApp on systems with no graphics acceleration, the system variable „QT_QUICK_BACKEND“ can be set to the value „software“. In this case, the AusweisApp does not attempt to use graphics acceleration and starts directly with the alternative software renderer.
macOS
MacOS does not provide a command line installation. However, some of the above settings can be specified system-wide by a plist file in the /Library/Preferences directory. This plist file must be manually stored by the administrator of the system and will be used by all (future) installations of AusweisApp. All not mentioned settings are not supported on macOS. The name of the file must be „com.governikus.AusweisApp2.plist“. The content is shown below:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>autoCloseWindow</key>
<false/>
<key>remindToClose</key>
<false/>
<key>uiStartupModule</key>
<string>DEFAULT</string>
<key>transportPinReminder</key>
<false/>
<key>customProxyType</key>
<string>HTTP</string>
<key>customProxyHost</key>
<string>proxy.example.org</string>
<key>customProxyPort</key>
<integer>1337</integer>
<key>keylessPassword</key>
<true/>
<key>shuffleScreenKeyboard</key>
<true/>
<key>visualPrivacy</key>
<true/>
<key>enableCanAllowed</key>
<true/>
<key>skipRightsOnCanAllowed</key>
<true/>
</dict>
</plist>
The description for each value is applicable for both Windows and macOS, although the naming of the attributes differs, as shown in the following table:
macOS |
Windows |
---|---|
autoCloseWindow |
AUTOHIDE |
remindToClose |
REMINDTOCLOSE |
uiStartupModule |
ASSISTANT |
transportPinReminder |
TRANSPORTPINREMINDER |
customProxyType |
CUSTOMPROXYTYPE |
customProxyPort |
CUSTOMPROXYPORT |
customProxyHost |
CUSTOMPROXYHOST |
keylessPassword |
ONSCREENKEYBOARD |
shuffleScreenKeyboard |
SHUFFLESCREENKEYBOARD |
visualPrivacy |
SECURESCREENKEYBOARD |
enableCanAllowed |
ENABLECANALLOWED |
skipRightsOnCanAllowed |
SKIPRIGHTSONCANALLOWED |
It might be necessary to force a reload of the data cached by the operating
system: killall -u $USER cfprefsd
Operational Environment Requirements
Used network ports
All network ports used by the AusweisApp are listed in Tab. 3. Abb. 2 shows a schematic representation of the individual connections made by the AusweisApp.
The AusweisApp starts a HTTP-Server on port 24727. The server binds only to the localhost network interface. The availability of the local server is necessary for the online eID function, because providers will redirect the user with a HTTP redirect to the local server to continue the authentication process in the AusweisApp (eID1). The server is also used to offer other local applications to use the AusweisApp via a websocket interface (SDK function, eID-SDK). Therefore local incoming network connections to TCP Port 24727 must be permitted.
If the proxy service is activated, the AusweisApp proxy takes over the server functions of AusweisApp on port 24727. The entities of AusweisApp recognize the proxy and use a free random port in this case to which the proxy forwards the requests.
Broadcast on UDP port 24727 in the local subnet have to be receivable by the AusweisApp to use the „Smartphone as Card Reader“ functionality. It may be necessary to deactivate AP isolation on your router.
Abb. 2 Communication model of the AusweisApp
The installer of the AusweisApp provides an option to register all needed firewall rules in the Windows Firewall. If the rules are not registered, the user will be prompted by the Windows Firewall to allow the outgoing connections once the AusweisApp tries to connect to a server. These prompts are suppressed by registering the firewall rules during installation. No rules have to be added to the Windows Firewall for the local connections eID1 and eID-SDK (when using the standard settings).
In table Tab. 4 all firewall rules registered by the installer are listed.
TLS connections
Transmitted TLS certificates are solely validated via the interlacing with the authorization certificate issued by the german eID PKI. CA certificates in the Windows truststore are thus ignored. It is therefore generally not possible to use the AusweisApp behind a TLS termination proxy.
Reference |
Protocol |
Port |
Direction |
Optional |
Purpose |
Note |
---|---|---|---|---|---|---|
eID1 |
TCP |
24727 [4] |
incoming |
no |
Online eID function, eID activation [5] |
Only accessible from localhost [5] |
eID2 |
TCP |
443 [6] |
outgoing |
no |
Online eID function, connection to the provider, TLS-1-2 channel [5] |
TLS certificates interlaced with authorization certificate [5] |
eID3 |
TCP |
443 [6] |
outgoing |
no |
Online eID function, connection to eID-Server, TLS-2 channel [5] |
TLS certificates interlaced with authorization certificate [5] |
eID-SDK |
TCP |
24727 [4] |
incoming |
no |
Usage of the SDK functionality |
Only accessible from localhost [5] |
SaC1 |
UDP |
24727 [4] |
incoming |
yes |
Smartphone as Card Reader, detection [7] |
Broadcasts |
SaC2 |
TCP |
outgoing |
yes |
Smartphone as Card Reader, usage [7] |
Connection in local subnet |
|
Update |
TCP |
443 |
outgoing |
yes |
Updates [8] of provider and card reader information as well as information on new AusweisApp versions [9] . |
TLS certificates will be validated against CA certificates included in the AusweisApp. CA certificates provided by the OS are ignored. |
Or a random port when using AusweisApp proxy.
See TR-03124 specification from the BSI
Port 443 is used for the initial contact with the provider or eID server. Due to configuration of the service on the service provider’s behalf, any other port might be used by forwarding.
See TR-03112-6 specifiaction from the BSI
All updates are based on the URL https://appl.governikus-asp.de/ausweisapp2/
Automatic checks for new AusweisApp versions can be deactivated, see commandline parameter UPDATECHECK.
Name |
Protocol |
Port |
Direction |
Connection reference |
---|---|---|---|---|
AusweisApp-Firewall-Rule |
TCP |
* |
outgoing |
eID2, eID3, SaC2, Update |
AusweisApp-SaC |
UDP |
24727 |
incoming |
SaC1 |
Developer Options
AusweisApp features so-called developer options, available for the supported operating systems of Windows and macOS. They facilitate the integration of eID services.
Windows & macOS
Developer options are activated by the version number accessible via „Help“ -> „Version Information“ 10 times. This is applicable for both Windows and macOS. Once activated, the developer options are accessible via „Settings“.
Android & iOS
The mobile version of AusweisApp does not feature the developer mode. Solely the test mode (Test-PKI) for self-authentication may be activated and deactivated by clicking the magnifying glass on the start screen 10 times.
Settings
Developer options allow to adjust two different settings:
Test mode for self-authentication (Test-PKI)
In general, the self-authentication is a built-in service of AusweisApp and can only be used with genuine ID cards. However, when in test mode, AusweisApp uses a test service allowing for self-authentication with a test ID card.
Developer mode
When the developer mode is activated, some safety measures during an authentication process are ignored. Ignoring the safety measures with test services usually employed in test scenarios, yields a successful authentication. For example, secure TLS connections (https) as well as insecure connections without TLS (http) are accepted. Invalid certificates will be ignored. Each safety breach will be highlighted as an internal notification in AusweisApp or the operating system respectively.
Please note: Developer mode can only be used for test services, usage with genuine provider certificates is not possible.