.\" 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
.\" ========================================================================
.\"
.IX Title "MIME::Base64::URLSafe 3pm"
.TH MIME::Base64::URLSafe 3pm "2022-11-27" "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"
MIME::Base64::URLSafe \- Perl version of Python's URL\-safe base64 codec
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use MIME::Base64::URLSafe;
\&  
\&  $encoded = urlsafe_b64encode(\*(AqAlladdin: open sesame\*(Aq);
\&  $decoded = urlsafe_b64decode($encoded);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is a perl version of python's URL-safe base64 encoder / decoder.
.PP
When embedding binary data in \s-1URL,\s0 it is preferable to use base64 encoding.  However, two characters ('+' and '/') used in the standard base64 encoding have special meanings in URLs, often leading to re-encoding with URL-encoding, or worse, interoperability problems.
.PP
To overcome the problem, the module provides a variation of base64 codec compatible with python's urlsafe_b64encode / urlsafe_b64decode.
.PP
Modification rules from base64:
.PP
.Vb 3
\&    use \*(Aq\-\*(Aq and \*(Aq_\*(Aq instead of \*(Aq+\*(Aq and \*(Aq/\*(Aq
\&    no line feeds
\&    no trailing equals (=)
.Ve
.PP
The following functions are provided:
.PP
.Vb 2
\&    urlsafe_b64encode($str)
\&    urlsafe_b64decode($str)
.Ve
.PP
If you prefer not to import these routines to your namespace, you can call them as:
.PP
.Vb 3
\&    use MIME::Base64::URLSafe ();
\&    $encoded = MIME::Base64::URLSafe::encode($decoded);
\&    $decoded = MIME::Base64::URLSafe::decode($encoded);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MIME::Base64
.PP
Fore more discussion on using base64 encoding in \s-1URL\s0 applications, see: http://en.wikipedia.org/wiki/Base64#URL_Applications
.SH "AUTHOR"
.IX Header "AUTHOR"
Kazuho Oku <kazuho _\|_\|_at_\|_\|_ labs.cybozu.co.jp>
.PP
Copyright (C) 2006 Cybozu Labs, Inc.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.7 or,
at your option, any later version of Perl 5 you may have available.