broadfield-dev commited on
Commit
54b5dfd
·
verified ·
1 Parent(s): 8032156

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -1
README.md CHANGED
@@ -7,4 +7,30 @@ sdk: static
7
  pinned: false
8
  ---
9
 
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  pinned: false
8
  ---
9
 
10
+ # Secure KeyLock Decoder API
11
+
12
+ This is a server-side API plugin running in a Docker container on Hugging Face Spaces. It provides a secure endpoint to decrypt messages from images created with the KeyLock application.
13
+
14
+ ## How It Works
15
+
16
+ 1. **Encryption**: A user encrypts a secret message (e.g., credentials) into a PNG image using this plugin's **Public Key**.
17
+ 2. **API Call**: The user's application sends this PNG file to this Space's `/api/decode` endpoint.
18
+ 3. **Secure Decryption**: This server uses its corresponding **Private Key**, stored securely as a Hugging Face Secret, to decrypt the data from the image.
19
+ 4. **Response**: The server returns the decrypted data as a JSON object.
20
+
21
+ ---
22
+
23
+ ### Plugin's Public Key
24
+
25
+ Provide this public key to users who need to encrypt data for this service.
26
+
27
+ ```pem
28
+ -----BEGIN PUBLIC KEY-----
29
+ MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAy2sWjB1iQ3vK03U7e/9E
30
+ O6J1K/s0tBq4Pz8F3r9/i8s7t9R1p8Z4Y6h4f4O7w9p9Z0c8t7m4J1e9g7K9m6f3
31
+ R1k3y7v1w0l7z6s5v2l8l4t9v8z7y6t5k2x1c9v7z3k1y9w8r5t3s1v9a8d7g6f5
32
+ e4d3c2b1a9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2
33
+ c1b0a9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0
34
+ a9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8
35
+ e7d6
36
+ -----END PUBLIC KEY-----