.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RDF::Crypt::Role::DoesSign 3pm"
.TH RDF::Crypt::Role::DoesSign 3pm "2012-06-25" "perl v5.14.2" "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 .
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster .
.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\s0 \s-1PACKAGE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R" \s-1AND\s0 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1EXPRESS\s0 \s-1OR\s0 \s-1IMPLIED\s0
\&\s-1WARRANTIES\s0, \s-1INCLUDING\s0, \s-1WITHOUT\s0 \s-1LIMITATION\s0, \s-1THE\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0
\&\s-1MERCHANTIBILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.