Unofficial C# Otto download demo
A working example of the Otto library implementation in C#.
Notice: This demo is not intended for productive usage!
ELSTER introduced on May 27th, 2024, a new library called Otto, which can be used to download objects from OTTER (Object Storage in ELSTER). The reason why ELSTER introduced the project and library is, that the current solution hit its limits. Otto was introduced together with a new version of Datenabholung.
The currently available way of data retrieval with ERiC will be replaced client-side in ERiC version 41 (end November 2024; only Datenabholung v31 will be available) and server-side with the planned yearly minimal version increase mid-April 2025 (exact date TBA in 2025; only ERiC >= v41 with Datenabholung v31 can be used after that date). Therefore, a majority of software developers using currently ERiC Datenabholung will have to implement Otto in production by April 2025.
./csotto
-u objectUuid UUID of object to download (mandatory)
-e extension Set filename extension of downloaded content [default: "txt"]
-p password Password for certificate [default: "123456"]
-f Force file overwriting [default: false]Examples:
csotto -u 468a69d4-0151-4681-9e8d-fcd87873d550 # ELOProtokoll / Lohnersatzleistung
csotto -u e694eca1-7251-4629-a164-4634db811189 -e pdf # DivaBescheidEStNotice: The code and scripts have been tested so far only on Linux and macOS. Windows is pending tests.
Hint: A list of object UUIDs is available with test certificates. You can get a list of them using PostfachAnfrage with the test certificate. The examples above are for test-softorg-pse.pfx and might be removed from the test instance after the time specified in the metadata.
You need the official ELSTER Otto library. Download the ERiC package v40 for your platform from the ELSTER developer area, unzip it and place it at a desired path. Feel free to place it in ./vendor/. You need two libraries: otto and eSigner (platform dependent naming: (lib)otto.{so|dylib|dll} and (lib)eSigner.{so|dylib|dll}).
Notice: The ERiC package, especially the included there libraries are subject to a separate license agreement (presented before download in the ELSTER developer area and included in the ERiC package itself).
Hint: Choose the right library for the platform you compile and run on.
You can build the code with Docker using:
make docker-buildHints: place the Otto library in ./vendor/. You could provide alternatively LD_LIBRARY_PATH environment variable on Linux or DYLD_LIBRARY_PATH on macOS during runtime.
Build with a tool of your choice and set up the project accordingly. Just don't forget to place the Otto library where the build solution can find it. For example PATH, typical places where libraries are searched on your system or just place it next to the build executable.
Here is an example howto run csotto locally on macOS after installing .NET 8.0.
# Clone repository
git clone git@github.com:rechtlogisch/csotto.git
# Change to directory with source code
cd csotto
# Retrieve test certificate to "certificate" subdirectory
./get-test-certificate.sh
# Build with dotnet
dotnet build
# Run `csotto`, provide objectUuid with -u option, DYLD_LIBRARY_PATH pointing to Otto library and your DEVELOPER_ID inline
DYLD_LIBRARY_PATH="./vendor" DEVELOPER_ID="00000" dotnet run -u 468a69d4-0151-4681-9e8d-fcd87873d550Notice: You should set your five-digit Developer-ID (German: Hersteller-ID) as the environment variable DEVELOPER_ID. You could source it from for example .env or pass it inline to csotto, as shown in the steps above.
Hint: The downloaded result will be saved in the same directory as csotto, unless you provide a different PATH_DOWNLOAD.
All supported environment variables are listed in .env.example. Feel free to copy them to .env, adjust accordingly and source for usage.
A simple Dockerfile is included. You can use make docker-build and make docker-csotto to build and run csotto in a container.
Hint: Set PATH_DOWNLOAD and PATH_LOG environment variables to expose data outside the container.
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security-related issues, please email open-source@rechtlogisch.de instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
The ERiC package, especially libraries, is not included in this repository and is subject to a separate license agreement. Please see the ELSTER developer area or the lizenz.pdf included in the ERiC package for more information.
This demo was developed by RL Recht logisch GmbH & Co. KG and should be used only for test purposes.
ELSTER is a registered trademark of the Freistaat Bayern, represented by the Bayerische Staatsministerium der Finanzen.