base64.rb

# frozen_string_literal: true
#
# = base64.rb: methods for base64-encoding and -decoding strings
#

# The Base64 module provides for the encoding (#encode64, #strict_encode64,
# #urlsafe_encode64) and decoding (#decode64, #strict_decode64,
# #urlsafe_decode64) of binary data using a Base64 representation.
#
# == Example
#
# A simple encoding and decoding.
#
#     require "base64"
#
#     enc   = Base64.encode64('Send reinforcements')
#                         # -> "U2VuZCByZWluZm9yY2VtZW50cw==\n"
#     plain = Base64.decode64(enc)
#                         # -> "Send reinforcements"
#
# The purpose of using base64 to encode data is that it translates any
# binary data into purely printable characters.

module Base64
  module_function

# Returns the Base64-encoded version of +bin+.
  # This method complies with RFC 2045.
  # Line feeds are added to every 60 encoded characters.
  #
  #    require 'base64'
  #    Base64.encode64("Now is the time for all good coders\nto learn Ruby")
  #
  # <i>Generates:</i>
  #
  #    Tm93IGlzIHRoZSB0aW1lIGZvciBhbGwgZ29vZCBjb2RlcnMKdG8gbGVhcm4g
  #    UnVieQ==
  def encode64(bin)
    [bin].pack("m")
  end

# Returns the Base64-decoded version of +str+.
  # This method complies with RFC 2045.
  # Characters outside the base alphabet are ignored.
  #
  #   require 'base64'
  #   str = 'VGhpcyBpcyBsaW5lIG9uZQpUaGlzIG' +
  #         'lzIGxpbmUgdHdvClRoaXMgaXMgbGlu' +
  #         'ZSB0aHJlZQpBbmQgc28gb24uLi4K'
  #   puts Base64.decode64(str)
  #
  # <i>Generates:</i>
  #
  #    This is line one
  #    This is line two
  #    This is line three
  #    And so on...
  def decode64(str)
    str.unpack1("m")
  end

# Returns the Base64-encoded version of +bin+.
  # This method complies with RFC 4648.
  # No line feeds are added.
  def strict_encode64(bin)
    [bin].pack("m0")
  end

# Returns the Base64-decoded version of +str+.
  # This method complies with RFC 4648.
  # ArgumentError is raised if +str+ is incorrectly padded or contains
  # non-alphabet characters.  Note that CR or LF are also rejected.
  def strict_decode64(str)
    str.unpack1("m0")
  end

# Returns the Base64-encoded version of +bin+.
  # This method complies with ``Base 64 Encoding with URL and Filename Safe
  # Alphabet'' in RFC 4648.
  # The alphabet uses '-' instead of '+' and '_' instead of '/'.
  # Note that the result can still contain '='.
  # You can remove the padding by setting +padding+ as false.
  def urlsafe_encode64(bin, padding: true)
    str = strict_encode64(bin)
    str.tr!("+/", "-_")
    str.delete!("=") unless padding
    str
  end

# Returns the Base64-decoded version of +str+.
  # This method complies with ``Base 64 Encoding with URL and Filename Safe
  # Alphabet'' in RFC 4648.
  # The alphabet uses '-' instead of '+' and '_' instead of '/'.
  #
  # The padding character is optional.
  # This method accepts both correctly-padded and unpadded input.
  # Note that it still rejects incorrectly-padded input.
  def urlsafe_decode64(str)
    # NOTE: RFC 4648 does say nothing about unpadded input, but says that
    # "the excess pad characters MAY also be ignored", so it is inferred that
    # unpadded input is also acceptable.
    str = str.tr("-_", "+/")
    if !str.end_with?("=") && str.length % 4 != 0
      str = str.ljust((str.length + 3) & ~3, "=")
    end
    strict_decode64(str)
  end
end

docroot: /home/induvedam/public_html

curdir: /opt/alt/ruby27/share/ruby

	.	4096
	..	101
X	English.rb	6258
X	abbrev.rb	3529
X	base64.rb	3379
	benchmark	24
X	benchmark.rb	18453
	bigdecimal	89
X	bigdecimal.rb	24
	cgi	119
X	cgi.rb	10037
X	coverage.rb	368
	csv	173
X	csv.rb	55643
X	date.rb	1066
X	debug.rb	30624
	delegate	24
X	delegate.rb	11343
	did_you_mean	4096
X	did_you_mean.rb	3806
	digest	21
X	digest.rb	2894
	drb	4096
X	drb.rb	50
X	erb.rb	29504
X	expect.rb	2217
	fiddle	142
X	fiddle.rb	1722
X	fileutils.rb	49211
X	find.rb	2526
	forwardable	39
X	forwardable.rb	9130
	getoptlong	24
X	getoptlong.rb	15787
	io	21
X	ipaddr.rb	19989
	irb	4096
X	irb.rb	27603
	json	91
X	json.rb	1809
X	kconv.rb	5861
	logger	118
X	logger.rb	16792
	matrix	87
X	matrix.rb	61703
X	mkmf.rb	88539
X	monitor.rb	6920
X	mutex_m.rb	2214
	net	149
	observer	24
X	observer.rb	5971
X	open-uri.rb	26088
	open3	24
X	open3.rb	22336
	openssl	150
X	openssl.rb	469
X	optionparser.rb	59
	optparse	119
X	optparse.rb	60919
	ostruct	24
X	ostruct.rb	10785
X	pathname.rb	16558
X	pp.rb	15978
X	prettyprint.rb	16276
X	prime.rb	12670
	pstore	24
X	pstore.rb	15063
	psych	4096
X	psych.rb	21718
	racc	4096
X	racc.rb	137
X	readline.rb	113
	reline	4096
X	reline.rb	13253
X	resolv-replace.rb	1805
X	resolv.rb	79629
	rexml	4096
	rinda	58
	ripper	69
X	ripper.rb	2494
	rss	4096
X	rss.rb	2963
X	securerandom.rb	9528
X	set.rb	24622
X	shellwords.rb	6816
	singleton	24
X	singleton.rb	4158
X	socket.rb	44702
	syslog	23
X	tempfile.rb	11213
X	time.rb	24590
	timeout	24
X	timeout.rb	4075
X	tmpdir.rb	4142
	tracer	24
X	tracer.rb	6640
X	tsort.rb	14642
X	un.rb	10202
	unicode_normalize	43
	uri	4096
X	uri.rb	3039
	vendor_ruby	6
X	weakref.rb	1473
	webrick	4096
X	webrick.rb	6890
	yaml	36
X	yaml.rb	1845