Nops.Core.GcpKms 1.0.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Nops.Core.GcpKms --version 1.0.0
                    
NuGet\Install-Package Nops.Core.GcpKms -Version 1.0.0
                    
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="Nops.Core.GcpKms" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Nops.Core.GcpKms" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Nops.Core.GcpKms" />
                    
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 Nops.Core.GcpKms --version 1.0.0
                    
#r "nuget: Nops.Core.GcpKms, 1.0.0"
                    
#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 Nops.Core.GcpKms@1.0.0
                    
#: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=Nops.Core.GcpKms&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Nops.Core.GcpKms&version=1.0.0
                    
Install as a Cake Tool

Nops.Core.GcpKms

Google Cloud KMS master key provider for Nops - in-process SOPS decryption.

Installation

dotnet add package Nops.Core.GcpKms

Usage

using Nops.Core;
using Nops.Core.Keys;

// Option 1: Application Default Credentials (ADC)
var masterKey = new GcpKmsMasterKey(
    resourceName: "projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key"
);

// Option 2: Explicit client with service account credentials
var client = KeyManagementServiceClient.Create(); // uses ADC by default

var masterKey2 = new GcpKmsMasterKey(
    resourceName: "projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key",
    client: client
);

// Use with SopsFile
var result = await SopsFile.DecryptTreeAsync(
    fileBytes: File.ReadAllBytes("secrets.sops.yaml"),
    fileKind: "yaml",
    options: new SopsOptions
    {
        MasterKeys = new[] { masterKey }
    });

Authentication

GCP KMS uses Application Default Credentials (ADC):

  1. Google Cloud SDK: gcloud auth application-default login
  2. Service account key: Set GOOGLE_APPLICATION_CREDENTIALS to the path of a JSON key file
  3. GCE/GKE/GAE default service accounts: Automatic when running on Google Cloud

IAM Permissions

Minimum IAM role for KMS decrypt:

roles/cloudkms.cryptoKeyDecrypter

Or custom policy:

{
  "permissions": [
    "cloudkms.cryptoKeys.get",
    "cloudkms.cryptoKeys.decrypt"
  ]
}

Running Tests

Unit tests run without dependencies:

dotnet test tests/Nops.Core.GcpKms.Tests --filter FullyQualifiedName~GcpKmsEntryParserTests

Integration tests need real GCP credentials (Application Default Credentials) and a key you can decrypt with:

GCP_LIVE_TEST=1 dotnet test tests/Nops.Core.GcpKms.Tests --filter FullyQualifiedName~GcpKmsIntegrationTests

License

MIT - see LICENSE.

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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.1 117 10/25/2026
1.1.0 102 10/25/2026
1.0.0 107 10/25/2026
1.0.0-preview.1 73 10/10/2026