diff --git a/README.md b/README.md index ec9972a..74c8d90 100644 --- a/README.md +++ b/README.md @@ -6,24 +6,27 @@ This Application is an OPC UA Global Discovery Server for certificate management The Application provides an OPC UA endpoint with the URL: "opc.tcp://HOSTNAME:58810/GlobalDiscoveryServer". -At this Endpoint OPC UA Applications which support the Pull Model can register. +At this Endpoint OPC UA Application which support the Pull Model can register. For registering OPC UA Applications that support the Push Model a separate OPC UA GDS Client is needed, e g. the one provided by the OPC Foundation as a Windows Application: https://github.com/OPCFoundation/UA-.NETStandard-Samples/tree/master/Samples/GDS For registering with the GDS the following credentails can be used: -The sample GDS servers only implements the username/password authentication. The following combinations can be used to connect to the server: +The sample GDS servers only implement the username/password authentication. The following combinations can be used to connect to the servers: GDS Administrator: Username: appadmin, PW: demo + This user has the ability to register and unregister applications and to issue new certificates. It should be used by the GDS Client application to connect. GDS User: Username: appuser, PW: demo + This user has only a limited ability to search for applications. System Administrator: Username: sysadmin, PW: demo + This user is defined for server push management and has the ability to access the server configuration nodes of the GDS server to update the server certificate and the trust lists. Server push configuration management is not a requirement for a GDS server and only supported here to demonstrate the functionality. ## REST Features @@ -42,19 +45,14 @@ The application depends on a Micorosft SQL Server Database to work. For seamless deployment use the Docker-Compose file to setup the Application + the Database with ease. -1. wget https://raw.githubusercontent.com/romanett/GDSwithREST/master/docker-compose.yml - -2. docker compose up - ## How to switch to local references with fixes instead of the upstream NuGet packages -1. Clone https://github.com/romanett/UA-.NETStandard -> swith to Branch allFixes -2. Clone https://github.com/romanett/GDSwithREST/ -> switch to branch BetaGDSReference -3. Put both Projects into the same respository -4. Add Reference to Nuget Package Bouncy Castle 2.2.1 in Project GDSwith REST +1. Clone https://github.com/romanett/UA-.NETStandard +2. Switch to branch https://github.com/romanett/GDSwithREST/tree/BetaGDSReference -> clone +3. Put both Projects into the same folder 5. Build Project Opc.Ua.Gds.Server.Common 6. Build Project GDSwithREST -7. Run the GDSwithREST using docker compose up +7. Run the GDSwithREST using docker-compose up ## Disclaimer @@ -64,6 +62,7 @@ It is not tested and not meant for use in a productive environment. In the current implementation severe security concerns apply: - the database password is contained in the docker compose file as well as the application.config - full access to the db is granted via the SA user + - the selfsigned server certificate & pw is stored in the git repository - the API can be accessed without authentification - No logging is implemented - The OPC UA Endpoint uses a hardcoded PW