Difference between revisions of "Web Statement"
Jon Phillips (talk | contribs) |
|||
| (23 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | = | + | <div style="border:1px solid #c00;padding-left:10px; padding-right:10px; background:#eee;"> |
| + | === For Developers === | ||
| − | + | This is a developer-oriented document for a developer oriented feature. This has two implications: | |
| + | * Do not attempt to implement as a content creator. If your software doesn't transparently handle CC metadata for you (you should only have to select a license), do not attempt to do it yourself. | ||
| + | * Read our [[Embedded Metadata|non-technical account with explanatory comics]] first. | ||
| + | </div> | ||
| − | License metadata for | + | ==Rationale== |
| + | |||
| + | License metadata for web pages is published with the content it describes. If someone publishes false metadata, it can be taken down or corrected. | ||
But with non-web content (such as files on peer-to-peer networks), incorrect metadata can propagate around the network, since it's extremely difficult to get everyone to correct it. | But with non-web content (such as files on peer-to-peer networks), incorrect metadata can propagate around the network, since it's extremely difficult to get everyone to correct it. | ||
| Line 9: | Line 15: | ||
Our solution is to embed a link to a license info page that includes the license metadata, rather than including it directly in the file. For example: | Our solution is to embed a link to a license info page that includes the license metadata, rather than including it directly in the file. For example: | ||
| − | < | + | <div class="code"> |
| + | <code>mysong.mp3</code> links to <code>http://example.com/licenseinfo</code> (using ID3 tags) | ||
<code>http://example.com/licenseinfo</code> says the work is available under <code>http://creativecommons.org/licenses/by/2.0/</code> (using HTML and RDF) | <code>http://example.com/licenseinfo</code> says the work is available under <code>http://creativecommons.org/licenses/by/2.0/</code> (using HTML and RDF) | ||
| + | </div> | ||
| + | |||
| + | The URL for the page that includes license metadata for a file is known as a '''WebStatement''' URL after the name used in [[XMP]]. | ||
| + | |||
| + | The page at the WebStatement URL should also identify the licensed media file with a content-derived identifier (e.g., SHA1 hash, see example below) or other independently verifiable identifier so that a program can verify that the page is making a license assertion about the media file at hand. | ||
| − | + | This has additional benefits besides preventing the propagation of incorrect license metadata: the metadata can now be linked to and indexed by search engines. Imagine searching the Web for music under a Creative Commons license, and then downloading it from a peer-to-peer network. | |
| − | + | Third parties can also build authentication services that provide additional assurance that the data is valid. | |
| − | + | === Security Considerations === | |
| − | + | Software will automatically download the license info page. Security impact: Anyone who can get you to download their file, just like anyone who can get you to visit their web page, can get you to visit another page and discover your IP address. | |
| − | + | == Implementation == | |
| − | + | ===Embedding a link to the license info page=== | |
| − | + | Many [[:Category:Filetype|file formats]] support embedding CC license information; embedding a WebStatement is supported in {{#ask:[[Category:Filetype]] [[supports web statement::True]]}}. | |
| − | + | ===Publishing the license info page=== | |
| − | + | The license info page must have or HTTP redirect to a page that has a license notice for the file in question. (Readers should be ready to follow several HTTP redirects.) | |
| − | |||
| − | |||
| − | |||
| − | + | Example HTML fragment with [[RDFa]]: | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | <nowiki><span about="urn:sha1:MSMBC5VEUDLTC26UT5W7GZBAKZHCY2MD"> | |
| − | + | Example_Song.mp3 is licensed under | |
| − | + | <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a> | |
| + | </span></nowiki> | ||
| − | + | This fragment includes the statement | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | <urn:sha1:MSMBC5VEUDLTC26UT5W7GZBAKZHCY2MD> :license <http://creativecommons.org/licenses/by/3.0/> . | |
| − | |||
| − | |||
| − | |||
| − | + | which may be read as "File with the SHA1 hash (base32 encoded) of MSMB... is licensed under CC BY 3.0." | |
| − | |||
| − | + | == Tools == | |
| − | + | [[ccPublisher]] and [[ccLookup]] offer GUI tools for MP3 license claim embedding and verification metadata generation. Available for Linux, OS X, and Windows. | |
| − | + | See [[XMP]] for tools and code for embedding XMP in PDF and JPEG formats. | |
| − | + | [[Category:Developer]] | |
| + | [[Category:Technology]] | ||
| + | [[Category:Metadata]] | ||
| − | + | __NOTOC__ | |
Latest revision as of 15:27, 12 May 2011
For Developers
This is a developer-oriented document for a developer oriented feature. This has two implications:
- Do not attempt to implement as a content creator. If your software doesn't transparently handle CC metadata for you (you should only have to select a license), do not attempt to do it yourself.
- Read our non-technical account with explanatory comics first.
Rationale
License metadata for web pages is published with the content it describes. If someone publishes false metadata, it can be taken down or corrected.
But with non-web content (such as files on peer-to-peer networks), incorrect metadata can propagate around the network, since it's extremely difficult to get everyone to correct it.
Our solution is to embed a link to a license info page that includes the license metadata, rather than including it directly in the file. For example:
mysong.mp3 links to http://example.com/licenseinfo (using ID3 tags)
http://example.com/licenseinfo says the work is available under http://creativecommons.org/licenses/by/2.0/ (using HTML and RDF)
The URL for the page that includes license metadata for a file is known as a WebStatement URL after the name used in XMP.
The page at the WebStatement URL should also identify the licensed media file with a content-derived identifier (e.g., SHA1 hash, see example below) or other independently verifiable identifier so that a program can verify that the page is making a license assertion about the media file at hand.
This has additional benefits besides preventing the propagation of incorrect license metadata: the metadata can now be linked to and indexed by search engines. Imagine searching the Web for music under a Creative Commons license, and then downloading it from a peer-to-peer network.
Third parties can also build authentication services that provide additional assurance that the data is valid.
Security Considerations
Software will automatically download the license info page. Security impact: Anyone who can get you to download their file, just like anyone who can get you to visit their web page, can get you to visit another page and discover your IP address.
Implementation
Embedding a link to the license info page
Many file formats support embedding CC license information; embedding a WebStatement is supported in {{#ask: supports web statement::True}}.
Publishing the license info page
The license info page must have or HTTP redirect to a page that has a license notice for the file in question. (Readers should be ready to follow several HTTP redirects.)
Example HTML fragment with RDFa:
<span about="urn:sha1:MSMBC5VEUDLTC26UT5W7GZBAKZHCY2MD">
Example_Song.mp3 is licensed under
<a rel="license" href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>
</span>
This fragment includes the statement
<urn:sha1:MSMBC5VEUDLTC26UT5W7GZBAKZHCY2MD> :license <http://creativecommons.org/licenses/by/3.0/> .
which may be read as "File with the SHA1 hash (base32 encoded) of MSMB... is licensed under CC BY 3.0."
Tools
ccPublisher and ccLookup offer GUI tools for MP3 license claim embedding and verification metadata generation. Available for Linux, OS X, and Windows.
See XMP for tools and code for embedding XMP in PDF and JPEG formats.
