Zzdats.Lgp.Common.Csso 10.2.1

Prefix Reserved
dotnet add package Zzdats.Lgp.Common.Csso --version 10.2.1
                    
NuGet\Install-Package Zzdats.Lgp.Common.Csso -Version 10.2.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Zzdats.Lgp.Common.Csso" Version="10.2.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Zzdats.Lgp.Common.Csso" Version="10.2.1" />
                    
Directory.Packages.props
<PackageReference Include="Zzdats.Lgp.Common.Csso" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Zzdats.Lgp.Common.Csso --version 10.2.1
                    
#r "nuget: Zzdats.Lgp.Common.Csso, 10.2.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Zzdats.Lgp.Common.Csso@10.2.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Zzdats.Lgp.Common.Csso&version=10.2.1
                    
Install as a Cake Addin
#tool nuget:?package=Zzdats.Lgp.Common.Csso&version=10.2.1
                    
Install as a Cake Tool

Common-Core .NET10

Common-Csso repozitorijs satur savienojumu informācijas izgūšanas no CSSO servisa klientu.

Šis repozitorijs ir kā daļa no LGP .Net Core projekta.

Pakas

Pakas nosaukums

Zzdats.Lgp.Common.Csso

Izmantošana

            services.AddCssoProvider((opt) => {
                opt.Url = Configuration.GetValue<string>("Lgp:Infrastructure:Csso:Url");
            });

CSSO protokola atslēgas

CssoConnectionProvider (t.i., ne-Vault izmantošanas gadījums) pieprasa trīs papildu vērtības, kuras ir kopīgs noslēpums starp šo bibliotēku un CSSO serveri — tās nav vērtības, ko bibliotēka ģenerē vai zina pēc noklusējuma, un tās nekad nedrīkst tikt "hardkodētas" pirmkodā:

  • Md5Nonce — pievienots pieprasījuma parakstam pirms MD5 jaukšanas.
  • RequestEncryptionKey — 32 rakstzīmju (AES-256) atslēga, ar kuru tiek šifrēti pieprasījumi un atšifrētas CSSO servera atbildes.
  • PasswordEncryptionKey — atslēga, ar kuru tiek aizklāta parole, ko sūta CSSO serverim.

Šīs vērtības jānorāda konfigurācijā (piemēram, appsettings.{Environment}.json, vides mainīgajos vai jebkurā citā IConfiguration avotā — nevis Vault; Vault šai bibliotēkā tiek izmantots tikai zemāk aprakstītajam datubāzes savienojuma virknes ieguves ceļam (VaultConnectionProvider), kas šīs CSSO protokola atslēgas neizmanto), saskaņojot tās ar CSSO servera puses konfigurāciju. Vides mainīgo nosaukumi ir aprakstīti repozitorija saknē esošajā .env.example failā.

Ja kāda no šīm vērtībām nav iestatīta caur CssoConnectionProviderOptions, GetConnection(...) izmet CssoException ar ErrorCode = CssoErrorCode.InvalidConfiguration.

Atslēgu ielāde no failiem (Docker/Kubernetes secrets)

Produkcijas vidē (piemēram, Docker vai Kubernetes secrets, kas tiek montēti kā faili) atslēgas var ielādēt no failiem, norādot ceļu uz failu vides mainīgajos. Piemēram, Portainer Docker Swarm secrets (csso_md5_nonce, csso_request_encryption_key, csso_password_encryption_key), kas tiek montēti konteinerā:

LGP__INFRASTRUCTURE__CSSO__MD5NONCE_FILE=/run/secrets/csso_md5_nonce
LGP__INFRASTRUCTURE__CSSO__REQUESTENCRYPTIONKEY_FILE=/run/secrets/csso_request_encryption_key
LGP__INFRASTRUCTURE__CSSO__PASSWORDENCRYPTIONKEY_FILE=/run/secrets/csso_password_encryption_key

AddCssoProvider(...) šos failus nolasa automātiski (caur PostConfigure<CssoConnectionProviderOptions>), papildu izsaukumi nav vajadzīgi. Faila saturs pārraksta konfigurācijā norādīto vērtību; ja vides mainīgais nav iestatīts vai norādītais fails neeksistē/ir tukšs, attiecīgā atslēga netiek ietekmēta.

Ja CssoConnectionProviderOptions tiek piesaistīts bez AddCssoProvider (piemēram, ar Configuration.GetSection("Lgp:Infrastructure:Csso").Bind(options)), failus konfigurācijā zem Lgp:Infrastructure:Csso:... var ielādēt ar AddCssoProtocolKeysFromFiles:

webBuilder.ConfigureAppConfiguration((ctx, cfg) =>
{
    cfg.AddCssoProtocolKeysFromFiles();
});

Vault izmantošana KV1 Noslēpumu izgūšanai

Izmantošanai nepieciešams Startup klases metodei ConfigureServices pielikt:

            services.AddCssoProvider(options =>
            {
                // Šī rinda ielasīs visus Vault saistītos iestatījumus no IConfiguration
                Configuration.GetSection("Lgp:Infrastructure:Csso").Bind(options);
            });

Konfigurācijas opcijas (AddCssoProvider) var tikt iestatītas dažādos veidos:

  • No konfigurācijas failiem (appsettings.{Environment}.json)
  • No vides mainīgajiem (LGP__INFRASTRUCTURE__CSSO__...)
  • No komandrindas(dotnet run --Lgp:Infrastructure:Csso: ...)
  • Vai jebkura cita IConfiguration avota

Zemāk ir parādīts piemērs, kā izmantot konfigurāciju ar vides mainīgajiem.

Lai izgūtu datubāzēs konekciju vai citu noslēpumu, izmantojot vault, nepieciešams iestātīt šos vides mainīgos:

LGP__INFRASTRUCTURE__CSSO__VAULTADDR=
LGP__INFRASTRUCTURE__CSSO__VAULTROLEID=
LGP__INFRASTRUCTURE__CSSO__VAULTSECRETID=
LGP__INFRASTRUCTURE__CSSO__VAULTAPPROLE=
LGP__INFRASTRUCTURE__CSSO__VAULTSECRETPATH=
LGP__INFRASTRUCTURE__CSSO__VAULTSECRETPATHMOUNT=
LGP__INFRASTRUCTURE__CSSO__VAULTSECRETCODE=

Piezīme: VAULTSECRETID var arī izgūt no faila. Tad jāizmanto mainīgais LGP__INFRASTRUCTURE__CSSO__VAULTSECRETIDFILE, kur jānorāda ceļš uz failu, kas satur secretId vērtību. Ja abi mainīgie ir iestatīti, prioritāte tiek dota failam (VAULTSECRETIDFILE).

Lai izgūtu konekcijas tokenu, Vault sūtīt POST pieprasījumu uz adresi: {VAULTADDR}/v1/auth/{VAULTAPPROLE}/login, iekļaujot VAULTROLEID un VAULTSECRETID

Ja VAULTAPPROLE nav iestatīts, tad pēc Vault noklusējuma tas ir approle

Kad tokens ir iegūts, Vault sūtīts GET pieprasījumu uz adresi: {VAULTADDR}/v1/{VAULTSECRETPATHMOUNT}/{VAULTSECRETPATH}

Ja VAULTSECRETPATHMOUNT nav iestatīts, tad pēc Vault noklusējuma tas ir secret

Ar mainīgo VAULTSECRETCODE ir jānorada atslēgas nosaukumu, priekš json noslēpuma vērtības, ko grib izgūt.


Ja iestatīti šādi vides mainīgie:

VAULTADDR=https://vault_url
VAULTROLEID=testRoleID
VAULTSECRETID=testSecretID
VAULTSECRETPATH=test/mysecret/connection-string
VAULTSECRETCODE=password

Tad POST adrese būs https://vault_url/v1/auth/approle/login un GET adrese būs https://vault_url/v1/secret/test/mysecret/connection-string/login


Ja iestatīti šādi vides mainīgie:

VAULTROLEID=testRoleID
VAULTSECRETID=testSecretID
VAULTAPPROLE=secrets
VAULTSECRETPATH=test/mysecret/1/connection-string
VAULTSECRETPATHMOUNT=kv
VAULTSECRETCODE=password

Tad POST adrese būs https://vault_url/v1/auth/secrets/login un GET adrese būs https://vault_url/v1/kv/test/mysecret/1/connection-string/login

Ja visi dati ir korekti, tad rezultātā tiek izgūta VAULTSECRETCODE vērtība (X):

{
    password: X
}

VAULTSECRETPATH ir iespējams arī norādīt districtID, piemēram, šādi:

VAULTSECRETPATH=test/mysecret/{district_id}/connection-string

tad {district_id}, tiks aizvietots ar lietotnes LGP__INFRASTRUCTURE__SERVICE__DISTRICTID vērtību.

Vault KV2 atbalsts

Pēc noklusējuma tiek izmantots KV1. Lai lasītu no KV2 dziņa, konfigurācijā jānorāda:

LGP__INFRASTRUCTURE__CSSO__VAULTKVVERSION=2

KV2 gadījumā GET pieprasījums tiek sūtīts uz {VAULTADDR}/v1/{VAULTSECRETPATHMOUNT}/data/{VAULTSECRETPATH} (data/ daļu pievieno automātiski - to nedrīkst iekļaut VAULTSECRETPATH).

Kļūdu apstrāde

Vault kļūmju gadījumā (nepareiza konfigurācija, Vault nav sasniedzams, noslēpums neatrasts, u.tml.) GetConnection(...) izmet CssoException, kura ErrorCode lauks (CssoErrorCode) norāda kļūmes iemeslu.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Zzdats.Lgp.Common.Csso:

Package Downloads
Zzdats.Lgp.Common.JsonDB.Oracle

LGP JSON DB component Oracle database implementation for NetStandard 2.0

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
10.2.1 187 10/11/2026
10.2.0 109 10/9/2026