From b54792f6c4c01d601daba83bb1e4ad1bc8ee4233 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Thu, 17 Oct 2024 13:42:47 -0700 Subject: [PATCH 1/4] Clarify setting ta_url --- docs/manifest/understanding.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest/understanding.md b/docs/manifest/understanding.md index fa0d8982..4202b445 100644 --- a/docs/manifest/understanding.md +++ b/docs/manifest/understanding.md @@ -43,7 +43,7 @@ Manifests without time-stamps cease to be valid when the signing credential expi An RFC 3161 time-stamp enables you to prove the existence of a particular piece of data at a particular time. Think of it as a notary service for data. You present a piece of data (in this case, the C2PA claim data structure) and the third-party TSA verifies that it saw that data at a time that can be audited and is independently verifiable. -The time-stamp is typically defined as part of the signing information. You can set this via the c2patool `ta_url` field or by using the API. The time-stamp then appears in the `SignatureInfo` JSON object when reading the manifest store. +The time-stamp is typically defined as part of the signing information. You can set this by using C2PA Tool in the `ta_url` field or by using the SDK. The time-stamp then appears in the `SignatureInfo` JSON object when reading the manifest store. ## References From 53fbcae9da4df158218f48f4af10618f3d42577e Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Thu, 17 Oct 2024 13:56:19 -0700 Subject: [PATCH 2/4] copy edits --- docs/getting-started.mdx | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 54aaadc4..08bba16c 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -84,10 +84,10 @@ In practice, to use a certificate with the CAI SDK, follow this process: 1. Purchase security credentials (certificate and key) from a certificate authority. Either email protection or document signing certificates are valid. 2. Extract the certificate by using a tool such as OpenSSL. You could also host the certificate in a secure environment like a hardware security module (HSM). -3. Use one of the supporting CAI libraries or C2PA Tool to sign manifests using the certificate. +3. Use one of the supporting CAI libraries or C2PA Tool to sign manifests using the certificate. :::tip -For more details and a short tutorial example, see [Signing manifests](manifest/signing-manifests.md). +For a short tutorial example, see [Signing manifests](manifest/signing-manifests.md). For more information on how to get and use a signing certificate for production use, see [Getting and using a signing certificate](prod-cert.mdx). ::: ### Getting a security certificate @@ -159,25 +159,17 @@ The following diagram provides a high-level view of how to use the open-source C Applications can use the CAI SDK in several different ways: - Web pages can use the JavaScript library to display Content Credentials. -- Applications written in C++, Python, or Node.js can call C2PA Tool directly or use the APIs of the corresponding language libraries to: +- Applications can "shell out" to call C2PA Tool directly. +- Applications written in C++, Python, or Node.js can use the APIs of the corresponding language libraries to: - Create, modify, and sign manifests. - Embed manifests into media files. - Parse and validate manifests. Similarly, applications written in many programming languages can use the Rust Foreign Function Interface to call the Rust API and perform those same functions. - - ### Native desktop or mobile applications -Applications written in C++, Python, or Node.js can call C2PA Tool directly or use the corresponding language library APIs. CAI has prerelease versions of C++/C, Python, and Node.js libraries. As prerelease versions, these APIs are subject to change. +Applications written in C++, Python, or Node.js can use the corresponding language library APIs. CAI has prerelease versions of C++/C, Python, and Node.js libraries. As prerelease versions, these APIs are subject to change. Applications written in any language call C2PA Tool directly, though doing so is not highly scalable. Alternatively, native applications can use Rust's _Foreign Function Interface_ (FFI) to call functions in the Rust library. The FFI enables interoperability between Rust and code written in other languages. From c0b9af036dd0b40c30139308b4ef680256f7948f Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Thu, 17 Oct 2024 13:59:16 -0700 Subject: [PATCH 3/4] remove redundant sentence --- docs/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 08bba16c..4aa691cd 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -169,7 +169,7 @@ Similarly, applications written in many programming languages can use the Rust F ### Native desktop or mobile applications -Applications written in C++, Python, or Node.js can use the corresponding language library APIs. CAI has prerelease versions of C++/C, Python, and Node.js libraries. As prerelease versions, these APIs are subject to change. Applications written in any language call C2PA Tool directly, though doing so is not highly scalable. +Applications written in C++, Python, or Node.js can use the corresponding prerelease library APIs. Applications written in any language call C2PA Tool directly, though doing so is not highly scalable. Alternatively, native applications can use Rust's _Foreign Function Interface_ (FFI) to call functions in the Rust library. The FFI enables interoperability between Rust and code written in other languages. From 9b02ae4c85a2a6cc80cad73197a427016ea8c5c4 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Thu, 17 Oct 2024 14:01:21 -0700 Subject: [PATCH 4/4] fix awkward wording --- docs/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 4aa691cd..bbe99d6e 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -87,7 +87,7 @@ In practice, to use a certificate with the CAI SDK, follow this process: 3. Use one of the supporting CAI libraries or C2PA Tool to sign manifests using the certificate. :::tip -For a short tutorial example, see [Signing manifests](manifest/signing-manifests.md). For more information on how to get and use a signing certificate for production use, see [Getting and using a signing certificate](prod-cert.mdx). +For a short tutorial example, see [Signing manifests](manifest/signing-manifests.md). For more information on how to get and use a signing certificate in production, see [Getting and using a signing certificate](prod-cert.mdx). ::: ### Getting a security certificate