THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx
Difference between revisions of "Technical Team/SDPX 2.0 Provenance"
| Line 1: | Line 1: | ||
| − | < | + | <h2>Provenance</h2><p> </p><p>It is desirable to be able to know the provenance of SPDX data. This means being able to reliably know who declared what SPDX information when, and where applicable, for what reason.</p><p> </p><p>Components of SPDX Provenance include</p><ol><li>Signing of SPDX Data</li></ol><p> </p><p> </p><h2>SPDX Data Signing</h2><p>Since SPDX Data can be represented in both RDF and Tag, and since there is no standard mechanism for signing RDF or Tag data as such (as there is in DSig for XML), we are left to fall back to signing the octets of the file containing that SPDX data. This has a few implications:</p><ol><li>The signature must be a in a separate file from the SPDX file (Example: foo.spdx has foo.spdx.sig containing it's signature)</li><li>The SPDX file, once signed, must not be changed by downstream consumers of the file (because to change its octets would be to invalidate the signature).</li></ol><p> </p><h3>SPDX Signing Proposal</h3><p>SPDX files should optionally be signed using <a href="http://www.ietf.org/rfc/rfc2440.txt">RFC 2440</a> PGP ascii-armored detached signatures.</p><h2>GPG Example:</h2><h2>Sign a file with GPG</h2><pre>sjc-vpn2-814:~ hagbard$ gpg --armor --output example.txt.sig --detach-sig example.txt |
You need a passphrase to unlock the secret key for | You need a passphrase to unlock the secret key for | ||
user: "Ed Warnicke " | user: "Ed Warnicke " | ||
1024-bit DSA key, ID 9AB88650, created 2001-09-09 | 1024-bit DSA key, ID 9AB88650, created 2001-09-09 | ||
| − | </pre>< | + | </pre><h2>See signature file</h2><pre>sjc-vpn2-814:~ hagbard$ cat example.txt.sig |
-----BEGIN PGP SIGNATURE----- | -----BEGIN PGP SIGNATURE----- | ||
Version: GnuPG/MacGPG2 v2.0.17 (Darwin) | Version: GnuPG/MacGPG2 v2.0.17 (Darwin) | ||
| Line 18: | Line 18: | ||
gpg: aka "Ed Warnicke " | gpg: aka "Ed Warnicke " | ||
Primary key fingerprint: 0B87 BC4A F6BF F571 FF9B BF51 A6AC E7EC 9AB8 8650 | Primary key fingerprint: 0B87 BC4A F6BF F571 FF9B BF51 A6AC E7EC 9AB8 8650 | ||
| − | </pre>< | + | </pre><h2>Implementation Notes:</h2><p>GPG is available for Linux, Mac, and Windows and provides PGP support. PGP support is available via the Legion of the Bouncy Castle in Java, and they provide an example <a href="http://www.jarvana.com/jarvana/view/org/bouncycastle/bcpg-jdk15/1.45/bcpg-jdk15-1.45-javadoc.jar!/org/bouncycastle/openpgp/examples/DetachedSignatureProcessor.html">DetachedSignatureProcessor</a> in their openpgp examples section.</p> |
Revision as of 18:17, 28 February 2012
Contents
Provenance
It is desirable to be able to know the provenance of SPDX data. This means being able to reliably know who declared what SPDX information when, and where applicable, for what reason.
Components of SPDX Provenance include
- Signing of SPDX Data
SPDX Data Signing
Since SPDX Data can be represented in both RDF and Tag, and since there is no standard mechanism for signing RDF or Tag data as such (as there is in DSig for XML), we are left to fall back to signing the octets of the file containing that SPDX data. This has a few implications:
- The signature must be a in a separate file from the SPDX file (Example: foo.spdx has foo.spdx.sig containing it's signature)
- The SPDX file, once signed, must not be changed by downstream consumers of the file (because to change its octets would be to invalidate the signature).
SPDX Signing Proposal
SPDX files should optionally be signed using <a href="http://www.ietf.org/rfc/rfc2440.txt">RFC 2440</a> PGP ascii-armored detached signatures.
GPG Example:
Sign a file with GPG
sjc-vpn2-814:~ hagbard$ gpg --armor --output example.txt.sig --detach-sig example.txt You need a passphrase to unlock the secret key for user: "Ed Warnicke " 1024-bit DSA key, ID 9AB88650, created 2001-09-09
See signature file
sjc-vpn2-814:~ hagbard$ cat example.txt.sig-----BEGIN PGP SIGNATURE----- Version: GnuPG/MacGPG2 v2.0.17 (Darwin) Comment: GPGTools - http://gpgtools.org
iEYEABECAAYFAk9NCpUACgkQpqzn7Jq4hlA3cACfUOxrlkISMjjLELGlLQuNn93h X6wAniliWFVoi7qfRGI79hwdLhajKcdI =0NsF -----END PGP SIGNATURE-----
Verify file with GPG
sjc-vpn2-814:~ hagbard$ gpg --verify example.txt.sig example.txtgpg: Signature made Tue Feb 28 11:10:45 2012 CST using DSA key ID 9AB88650 gpg: Good signature from "Ed Warnicke " gpg: aka "Ed Warnicke " Primary key fingerprint: 0B87 BC4A F6BF F571 FF9B BF51 A6AC E7EC 9AB8 8650
Implementation Notes:
GPG is available for Linux, Mac, and Windows and provides PGP support. PGP support is available via the Legion of the Bouncy Castle in Java, and they provide an example <a href="http://www.jarvana.com/jarvana/view/org/bouncycastle/bcpg-jdk15/1.45/bcpg-jdk15-1.45-javadoc.jar!/org/bouncycastle/openpgp/examples/DetachedSignatureProcessor.html">DetachedSignatureProcessor</a> in their openpgp examples section.
