.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "CAM::PDF::Decrypt 3pm"
.TH CAM::PDF::Decrypt 3pm "2022-12-08" "perl v5.36.0" "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"
CAM::PDF::Decrypt \- PDF security helper
.SH "LICENSE"
.IX Header "LICENSE"
See \s-1CAM::PDF.\s0
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use CAM::PDF;
\&    my $pdf = CAM::PDF\->new($filename);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is used invisibly by \s-1CAM::PDF\s0 whenever it detects that a
document is encrypted.  See \fBnew()\fR, \fBgetPrefs()\fR and \fBsetPrefs()\fR in that
module.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .IP "$pkg\->new($pdf, $ownerpass, $userpass, $prompt)" 4
.el .IP "\f(CW$pkg\fR\->new($pdf, \f(CW$ownerpass\fR, \f(CW$userpass\fR, \f(CW$prompt\fR)" 4
.IX Item "$pkg->new($pdf, $ownerpass, $userpass, $prompt)"
Create and validate a new decryption object.  If this fails, it will
set \f(CW$CAM::PDF::errstr\fR and return undef.
.Sp
\&\f(CW$prompt\fR is a boolean that says whether the user should be prompted for
a password on the command line.
.ie n .IP "$self\->decode_permissions($field)" 4
.el .IP "\f(CW$self\fR\->decode_permissions($field)" 4
.IX Item "$self->decode_permissions($field)"
Given a binary encoded permissions string from a \s-1PDF\s0 document, return
the four individual boolean fields as an array:
.Sp
.Vb 4
\&  print boolean
\&  modify boolean
\&  copy boolean
\&  add boolean
.Ve
.ie n .IP "$self\->encode_permissions($print, $modify, $copy, $add)" 4
.el .IP "\f(CW$self\fR\->encode_permissions($print, \f(CW$modify\fR, \f(CW$copy\fR, \f(CW$add\fR)" 4
.IX Item "$self->encode_permissions($print, $modify, $copy, $add)"
Given four booleans, pack them into a single field in the \s-1PDF\s0 style
that decode_permissions can understand.  Returns that scalar.
.ie n .IP "$self\->set_passwords($doc, $ownerpass, $userpass)" 4
.el .IP "\f(CW$self\fR\->set_passwords($doc, \f(CW$ownerpass\fR, \f(CW$userpass\fR)" 4
.IX Item "$self->set_passwords($doc, $ownerpass, $userpass)"
.PD 0
.ie n .IP "$self\->set_passwords($doc, $ownerpass, $userpass, $permissions)" 4
.el .IP "\f(CW$self\fR\->set_passwords($doc, \f(CW$ownerpass\fR, \f(CW$userpass\fR, \f(CW$permissions\fR)" 4
.IX Item "$self->set_passwords($doc, $ownerpass, $userpass, $permissions)"
.PD
Change the \s-1PDF\s0 passwords to the specified values.  When the \s-1PDF\s0 is
output, it will be encrypted with the new passwords.
.Sp
\&\s-1PERMISSIONS\s0 is an optional scalar of the form that decode_permissions
can understand.  If not specified, the existing values will be
retained.
.Sp
Note: we only support writing using encryption version 1, even though
we can read encryption version 2 as well.
.ie n .IP "$self\->encrypt($doc, $string)" 4
.el .IP "\f(CW$self\fR\->encrypt($doc, \f(CW$string\fR)" 4
.IX Item "$self->encrypt($doc, $string)"
Encrypt the scalar using the passwords previously specified.
.ie n .IP "$self\->decrypt($doc, $string)" 4
.el .IP "\f(CW$self\fR\->decrypt($doc, \f(CW$string\fR)" 4
.IX Item "$self->decrypt($doc, $string)"
Decrypt the scalar using the passwords previously specified.
.SH "AUTHOR"
.IX Header "AUTHOR"
See \s-1CAM::PDF\s0