.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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 "Safe::Hole 3"
.TH Safe::Hole 3 "2016-08-24" "perl v5.16.3" "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"
Safe::Hole \- make a hole to the original main compartment in the Safe compartment
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&  use Safe;
\&  use Safe::Hole;
\&  $cpt = new Safe;
\&  $hole = new Safe::Hole {};
\&  sub test { Test\->test; }
\&  $Testobj = new Test;
\&  # $cpt\->share(\*(Aq&test\*(Aq);  # alternate as next line
\&  $hole\->wrap(\e&test, $cpt, \*(Aq&test\*(Aq);
\&  # ${$cpt\->varglob(\*(AqTestobj\*(Aq)} = $Testobj;  # alternate as next line
\&  $hole\->wrap($Testobj, $cpt, \*(Aq$Testobj\*(Aq);
\&  $cpt\->reval(\*(Aqtest; $Testobj\->test;\*(Aq); 
\&  print $@ if $@;
\&  package Test;
\&  sub new { bless {},shift(); }
\&  sub test { my $self = shift; $self\->test2; }
\&  sub test2 { print "Test\->test2 called\en"; }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 7
\&  We can call outside defined subroutines from the Safe compartment
\&using share(), or can call methods through the object that is copied
\&into the Safe compartment using varglob(). But that subroutines or
\&methods are executed in the Safe compartment too, so they cannot call
\&another subroutines that are dinamically qualified with the package
\&name such as class methods nor can they compile code that uses opcodes
\&that are forbidden within the compartment.
\&
\&  Through Safe::Hole, we can execute outside defined subroutines in the 
\&original main compartment from the Safe compartment. 
\&
\&  Note that if a subroutine called through Safe::Hole::call does a
\&Carp::croak() it will report the error as having occured within
\&Safe::Hole.  This can be avoided by including Safe::Hole::User in the
\&@ISA for the package containing the subroutine.
.Ve
.SS "Methods"
.IX Subsection "Methods"
.IP "new [\s-1NAMESPACE\s0]" 4
.IX Item "new [NAMESPACE]"
Class method. Backward compatible constructor.
  \s-1NAMESPACE\s0 is the alternate root namespace that makes the compartment
in which \fIcall()\fR method execute the subroutine.  Default of \s-1NAMESPACE\s0
means the current 'main'. This emulates the behaviour of
Safe\-Hole\-0.08 and earlier.
.IP "new \e%arguments" 4
.IX Item "new %arguments"
Class method. Constructor. 
  The constructor is called with a hash reference providing the
constructor arguments.  The argument \s-1ROOT\s0 specifies the alternate root
namespace for the object.  If the \s-1ROOT\s0 argument is not specified then
Safe::Hole object will attempt restore as much as it can of the
environment in which it was constrtucted.  This includes the opcode
mask, \f(CW%INC\fR and \f(CW@INC\fR.  If a root namespace is specified then it
would not make sense to restore the \f(CW%INC\fR and \f(CW@INC\fR from main:: so this
is not done.  Also if a root namespace is given the opcode mask is not
restored either.
.ie n .IP "call $coderef [,@args]" 4
.el .IP "call \f(CW$coderef\fR [,@args]" 4
.IX Item "call $coderef [,@args]"
Object method. 
  Call the subroutine refered by \f(CW$coderef\fR in the compartment that is
specified with constructor new. \f(CW@args\fR are passed as the arguments to
the called \f(CW$coderef\fR.  Note that the arguments are not currently passed
by reference although this may change in a future version.
.ie n .IP "wrap $ref [,$cpt ,$name]" 4
.el .IP "wrap \f(CW$ref\fR [,$cpt ,$name]" 4
.IX Item "wrap $ref [,$cpt ,$name]"
Object method. 
  If \f(CW$ref\fR is a code reference, this method returns the anonymous 
subroutine reference that calls \f(CW$ref\fR using \fIcall()\fR method of Safe::Hole (see 
above). 
  If \f(CW$ref\fR is a class object, this method makes a wrapper class of that object 
and returns a new object of the wrapper class. Through the wrapper class, 
all original class methods called using \fIcall()\fR method of Safe::Hole.
  If \f(CW$cpt\fR as Safe object and \f(CW$name\fR as subroutine or scalar name specified, 
this method works like \fIshare()\fR method of Safe. When \f(CW$ref\fR is a code reference
\&\f(CW$name\fR must like '&subroutine'. When \f(CW$ref\fR is a object \f(CW$name\fR must like '$var'.
  Name \f(CW$name\fR may not be same as referent of \f(CW$ref\fR. For example:
  \f(CW$hole\fR\->wrap(\e&foo, \f(CW$cpt\fR, '&bar');
  \f(CW$hole\fR\->wrap(sub{...}, \f(CW$cpt\fR, '&foo');
  \f(CW$hole\fR\->wrap($objfoo, \f(CW$cpt\fR, '$objbar');
.IP "root" 4
.IX Item "root"
Object method.
Return the namespace that is specified with constructor \fInew()\fR.
If no namespace was then \fIroot()\fR returns 'main'.
.SS "Warning"
.IX Subsection "Warning"
You \s-1MUST NOT\s0 share the Safe::Hole object with the Safe compartment. If you do it
the Safe compartment is \s-1NOT\s0 safe.
.PP
This module provides a means to go from a state where an opcode is
denied back to a state where it is not.  Reasonable care has been
taken to ensure that programs cannot simply manipulate the internals
to the Safe::Hole object to reduce the opmask in effect.  However there
may still be a way that the authors have not considered.  In
particular it relies on the fact that a Perl program cannot change
stuff inside the magic on a Perl variable.  If you install a module
that allows a Perl program to fiddle inside the magic then this
assuption breaks down.  One would hope that any system that was
running un-trusted code would not have such a module installed.
.SH "AUTHORS"
.IX Header "AUTHORS"
Sey Nakajima <nakajima@netstock.co.jp> (Initial version)
.PP
Brian McCauley <nobull@cpan.org> (Maintenance)
.PP
Todd Rinaldo <toddr@cpan.org> (Maintenance)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fISafe\fR\|(3).