.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "RDF::Crypt::Role::DoesSign 3pm"
.TH RDF::Crypt::Role::DoesSign 3pm "2016-12-04" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
RDF::Crypt::Role::DoesSign \- signing methods
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "Object Methods"
.IX Subsection "Object Methods"
.ie n .IP """sign_model($model)""" 4
.el .IP "\f(CWsign_model($model)\fR" 4
.IX Item "sign_model($model)"
Given an RDF::Trine::Model, returns a signature as a string.
.Sp
The model is converted to a canonicalised N\-Triples representation (see
RDF::Trine::Serializer::NTriples::Canonical) with any triples that
cannot be canonicalised being truncated. This representation is then
signed using an \s-1MD5\s0 digest, and the resulting binary signature encoded
using base64.
.ie n .IP """generate_manifest($webid, \e@urls)""" 4
.el .IP "\f(CWgenerate_manifest($webid, \e@urls)\fR" 4
.IX Item "generate_manifest($webid, @urls)"
Given a WebID that people can use to recover your public key, and a
list of URLs that need signing, signs each and returns an
RDF::Trine::Model containing the results of processing. This
can be serialised as, say, Turtle to act as an endorsement for
a bunch of \s-1RDF\s0 graphs.
.ie n .IP """sign_embed_turtle($turtle, $baseuri)""" 4
.el .IP "\f(CWsign_embed_turtle($turtle, $baseuri)\fR" 4
.IX Item "sign_embed_turtle($turtle, $baseuri)"
Parses the given Turtle into a model, generates a signature for that
and then returns the original Turtle with the signature embedded as
a comment. This allows the signature to sit in the same file as the
data itself.
.Sp
The base \s-1URI\s0 is used to resolve any relative \s-1URI\s0 references. Note that
if a different base \s-1URI\s0 is provided when verifying the signature, this
may cause verification to fail. The base \s-1URI\s0 is optional.
.ie n .IP """sign_embed_rdfxml($xml, $baseuri)""" 4
.el .IP "\f(CWsign_embed_rdfxml($xml, $baseuri)\fR" 4
.IX Item "sign_embed_rdfxml($xml, $baseuri)"
As per \f(CW\*(C`sign_embed_turtle\*(C'\fR, but \s-1RDF/XML.\s0
.ie n .IP """sign_embed_rdfa($html, $baseuri, \e%config)""" 4
.el .IP "\f(CWsign_embed_rdfa($html, $baseuri, \e%config)\fR" 4
.IX Item "sign_embed_rdfa($html, $baseuri, %config)"
Similar to \f(CW\*(C`sign_embed_turtle\*(C'\fR and \f(CW\*(C`sign_embed_rdfxml\*(C'\fR. The base
\&\s-1URI\s0 is required. A set of configuration options may be provided,
which will be passed along to RDF::RDFa::Parser's constructor.
.Sp
Rather than storing the signature as an \s-1XML/HTML\s0 comment, the
signature is stored on the root element as an attribute.
.ie n .IP """sign_text($str)""" 4
.el .IP "\f(CWsign_text($str)\fR" 4
.IX Item "sign_text($str)"
Signs a literal string which may or may not have anything to do with \s-1RDF.\s0
.SS "Required Methods"
.IX Subsection "Required Methods"
This role does not implement these methods, but requires classes to
implement them instead:
.ie n .IP """sign_bytes($str)""" 4
.el .IP "\f(CWsign_bytes($str)\fR" 4
.IX Item "sign_bytes($str)"
Generates a signature for an octet string.
.ie n .IP """SIG_MARK""" 4
.el .IP "\f(CWSIG_MARK\fR" 4
.IX Item "SIG_MARK"
Returns a string used as a marker for signatures within serialised \s-1RDF.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RDF::Crypt,
RDF::Crypt::Signer.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to <http://rt.cpan.org/>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2010, 2012 Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
\&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0