Skip to content

Commit b94d9a8

Browse files
author
Rand McKinney
committed
comment out python example until we can make it public
1 parent 3e09287 commit b94d9a8

File tree

4 files changed

+18
-10
lines changed

4 files changed

+18
-10
lines changed

docs/c2pa-python-example/.gitkeep

Whitespace-only changes.

docs/prod-cert.mdx

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
---
22
id: prod-cert
3-
title: Configuring and using signing certificate in production
3+
title: Configuring and using a signing certificate in production
44
---
55

66
## Overview
77

8-
For convenience, C2PA Tool and the prerelease libraries include one or more [test certificates](manifest/signing-manifests#test-certificates) and a private key to use during development.
8+
For convenience, C2PA Tool, the Rust library, and the CAI prerelease libraries include one or more [test certificates](manifest/signing-manifests#test-certificates) to use during development, typically in the `tests/fixtures` directory.
99

10-
While these test certificates and keys are useful during development and testing, for production deployment you must purchase and configure your own certificate and private key. This page walks you through this process in detail.
10+
While these test certificates and keys are useful during development and testing, for production deployment you must purchase and configure your own certificate and private key.
1111

1212
Certificates and private keys are often stored on a hardware security module (HSM), a physical device that attaches directly to a computer or server and is used to securely manage and perform operations on cryptographic keys.
1313

1414
An HSM generates cryptographic keys and signs information without revealing private-key material to the outside world. These are hardened, intrusion-resistant devices that typically provide features like on-board key-generation, key storage and accelerated encryption. HSMs are commonly used in Public Key Cryptography (PKI) deployments to secure Certificate Authority keys.
1515

16-
This example uses [SoftHSM](https://www.opendnssec.org/softhsm/), a software implementation of a generic PKCS#11 device.
16+
## The Python example
1717

18-
### Procedure
19-
20-
1. Purchase cert.
21-
2. Install cert using HSM or other secure mechanism.
22-
3. Configure app to use cert.
18+
The [c2pa-python-example](https://github.com/contentauth/c2pa-python-example) app provides an example of constructing a certificate signing request to help you get started.

scripts/fetch-readme.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ const readmes = [
6969
repo: 'contentauth/c2pa-python',
7070
path: 'README.md',
7171
},
72+
/* {
73+
dest: resolve(__dirname, '../docs/c2pa-python-example/readme.md'),
74+
repo: 'contentauth/c2pa-python',
75+
path: 'README.md',
76+
branch: 'flesh-out-doc'
77+
}, */
7278
];
7379

7480
function resolveMarkdownLinks(linkBase, content) {

sidebars.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,12 @@ const sidebars = {
130130
label: 'GitHub',
131131
href: 'https://github.com/contentauth/c2pa-python',
132132
},
133+
/*
134+
{
135+
type: 'doc',
136+
id: 'c2pa-python-example/readme',
137+
},
138+
*/
133139
],
134140
},
135141
{
@@ -168,7 +174,7 @@ const sidebars = {
168174
},
169175
{
170176
type: 'doc',
171-
label: 'Using a signing certificate',
177+
label: 'Using a certificate in production',
172178
id: 'prod-cert',
173179
},
174180
{

0 commit comments

Comments
 (0)