Skip to content

Commit ecc4634

Browse files
author
Mélanie Marques
committed
feat(key_manager): add documentation about creating and verify digital signatures
1 parent 3c8842d commit ecc4634

File tree

1 file changed

+121
-0
lines changed

1 file changed

+121
-0
lines changed
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
meta:
3+
title: Create and validate signatures using Scaleway Go SDK and Key Manager
4+
description: Learn how to create and validate signature using Key Manager with Scaleway Go SDK.
5+
content:
6+
h1: Create and validate signatures using Scaleway Go SDK and Key Manager
7+
paragraph: Learn how to create and validate signature using Key Manager with Scaleway Go SDK.
8+
tags: key sensitive-data signature verification sign verify digest
9+
dates:
10+
validation: 2025-02-06
11+
posted: 2025-02-06
12+
---
13+
14+
This page shows you how to perform asymmetric signing and verification using Scaleway Key Manager (KMS).
15+
16+
In this tutorial, we will walk you through setting up your environment to interact with the Scaleway API and Key Manager,
17+
and then demonstrate how to sign and verify messages using asymmetric keys.
18+
19+
## Configuring your environment variables
20+
21+
Configuring your environment variables allows the Go application to authenticate and use Scaleway's API and Key Manager.
22+
23+
Open a terminal and paste the following commands to export your environment variables. Make sure that you add your **own variables**. You can also use a Scaleway configuration file.
24+
25+
```
26+
export SCW_ACCESS_KEY="<API-ACCESS-KEY>"
27+
export SCW_SECRET_KEY="<API-SECRET-KEY>"
28+
export SCW_DEFAULT_ORGANIZATION_ID="<Scaleway-Organization-ID>"
29+
export SCW_DEFAULT_REGION="<region>"
30+
export SCW_API_URL="<api-URL>"
31+
```
32+
33+
## Creating a signature
34+
35+
```
36+
// signAsymmetric signs a plaintext message using a saved asymmetric private key 'ec_p256_sha256'
37+
// stored in Scaleway Key Manager.
38+
//
39+
// Parameters:
40+
// - keyID: The unique identifier of the asymmetric key stored in Scaleway Key Manager.
41+
// - message: The plaintext message that needs to be signed.
42+
//
43+
// Returns:
44+
// - err: An error if the signing process fails, otherwise nil.
45+
func signAsymmetric(keyID string, message string) error {
46+
// Initialize the Scaleway client
47+
client, err := scw.NewClient(scw.WithEnv())
48+
if err != nil {
49+
panic(err)
50+
}
51+
kmsApi := key_manager.NewAPI(client)
52+
53+
// Convert the message into bytes. Cryptographic plaintexts and ciphertexts are always byte arrays.
54+
plaintext := []byte(message)
55+
56+
// Calculate the digest of the message.
57+
digest := sha256.New()
58+
if _, err = digest.Write(plaintext); err != nil {
59+
return fmt.Errorf("failed to create digest: %w", err)
60+
}
61+
62+
// Build the signing request.
63+
req := &key_manager.SignRequest{
64+
Digest: digest.Sum(nil),
65+
KeyID: keyID,
66+
}
67+
68+
// Call the API
69+
response, err = kmsApi.Sign(req)
70+
if err != nil {
71+
return fmt.Errorf("failed to sign digest: %w", err)
72+
}
73+
74+
fmt.Printf("Signed digest: %s", response.Signature)
75+
return nil
76+
}
77+
```
78+
79+
## Validating an elliptic curve signature
80+
81+
```
82+
// verifyAsymmetricSignature verifies that an 'ec_p256_sha256' signature is valid for a given message.
83+
//
84+
// Parameters:
85+
// - keyID: The unique identifier of the asymmetric key stored in Scaleway Key Manager.
86+
// - message: The plaintext message that was originally signed.
87+
// - signature: The signature obtained from a previous sign request.
88+
//
89+
// Returns:
90+
// - error: An error if the verification process fails or if the signature is invalid, otherwise nil.
91+
func verifyAsymmetricSignature(keyID string, message, signature []byte) error {
92+
// Initialize the Scaleway client
93+
client, err := scw.NewClient(scw.WithEnv())
94+
if err != nil {
95+
panic(err)
96+
}
97+
kmsApi := key_manager.NewAPI(client)
98+
99+
// Verify signature.
100+
// Calculate the digest of the message.
101+
digest := sha256.New()
102+
if _, err = digest.Write(message); err != nil {
103+
return fmt.Errorf("failed to create digest: %w", err)
104+
}
105+
106+
verify, err := kmsApi.Verify(&key_manager.VerifyRequest{
107+
KeyID: keyID,
108+
Digest: digest.Sum(nil),
109+
Signature: signature,
110+
})
111+
if err != nil {
112+
return err
113+
}
114+
115+
if verify.Valid {
116+
fmt.Printf("Verified signature!")
117+
}
118+
119+
return nil
120+
}
121+
```

0 commit comments

Comments
 (0)