.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::InputOutput::RequireEncodingWithUTF8Layer 3pm"
.TH Perl::Critic::Policy::InputOutput::RequireEncodingWithUTF8Layer 3pm 2023-07-26 "perl v5.38.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
Perl::Critic::Policy::InputOutput::RequireEncodingWithUTF8Layer \- Write "open $fh, q{<:encoding(UTF\-8)}, $filename;" instead of "open $fh, q{<:utf8}, $filename;".
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Use of the \f(CW\*(C`:utf8\*(C'\fR I/O layer (as opposed to \f(CW:encoding(UTF8)\fR or
\&\f(CW:encoding(UTF\-8)\fR) was suggested in the Perl documentation up to
version 5.8.8. This may be OK for output, but on input \f(CW\*(C`:utf8\*(C'\fR does not
validate the input, leading to unexpected results.
.PP
An exploit based on this behavior of \f(CW\*(C`:utf8\*(C'\fR is exhibited on PerlMonks
at <http://www.perlmonks.org/?node_id=644786>. The exploit involves a
string read from an external file and sanitized with \f(CW\*(C`m/^(\ew+)$/\*(C'\fR,
where \f(CW$1\fR nonetheless ends up containing shell meta-characters.
.PP
To summarize:
.PP
.Vb 3
\& open $fh, \*(Aq<:utf8\*(Aq, \*(Aqfoo.txt\*(Aq;             # BAD
\& open $fh, \*(Aq<:encoding(UTF8)\*(Aq, \*(Aqfoo.txt\*(Aq;   # GOOD
\& open $fh, \*(Aq<:encoding(UTF\-8)\*(Aq, \*(Aqfoo.txt\*(Aq;  # BETTER
.Ve
.PP
See the Encode documentation for the difference between
\&\f(CW\*(C`UTF8\*(C'\fR and \f(CW\*(C`UTF\-8\*(C'\fR. The short version is that \f(CW\*(C`UTF\-8\*(C'\fR implements the
Unicode standard, and \f(CW\*(C`UTF8\*(C'\fR is liberalized.
.PP
For consistency's sake, this policy checks files opened for output as
well as input. For complete coverage it also checks \f(CWbinmode()\fR calls,
where the direction of operation can not be determined.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
This Policy is not configurable except for the standard options.
.SH NOTES
.IX Header "NOTES"
Because \f(CW\*(C`Perl::Critic\*(C'\fR does a static analysis, this policy can not
detect cases like
.PP
.Vb 2
\& my $encoding = \*(Aq:utf8\*(Aq;
\& binmode $fh, $encoding;
.Ve
.PP
where the encoding is computed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
PerlIO
.PP
Encode
.PP
\&\f(CW\*(C`perldoc \-f binmode\*(C'\fR
.PP
<http://www.socialtext.net/perl5/index.cgi?the_utf8_perlio_layer>
.PP
<http://www.perlmonks.org/?node_id=644786>
.SH AUTHOR
.IX Header "AUTHOR"
Thomas R. Wyant, III \fIwyant at cpan dot org\fR
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2010\-2011 Thomas R. Wyant, III
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.