Puppet Function: base64

Defined in:
vendor_modules/stdlib/lib/puppet/parser/functions/base64.rb
Function type:
Ruby 3.x API

Summary

Base64 encode or decode a string based on the command and the string submitted

Overview

base64() ⇒ String

> *Note:

Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings.
See the `new()` function for the Binary and String types for documentation. Also see `binary_file()`
function for reading a file with binary (non UTF-8) content.

Examples:

Example usage


Encode and decode a string

  $encodestring = base64('encode', 'thestring')
  $decodestring = base64('decode', 'dGhlc3RyaW5n')

Explicitly define encode/decode method: default, strict, urlsafe

  $method = 'default'
  $encodestring = base64('encode', 'thestring', $method)
  $decodestring = base64('decode', 'dGhlc3RyaW5n', $method)

Encode a string as if it was binary

 $encodestring = String(Binary('thestring', '%s'))

Decode a Binary assuming it is an UTF-8 String

 $decodestring = String(Binary("dGhlc3RyaW5n"), "%s")

Returns:

  • (String) —

    The encoded/decoded va



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/base64.rb', line 5

newfunction(:base64, type: :rvalue, doc: <<-DOC) do |args|
  @summary
    Base64 encode or decode a string based on the command and the string submitted

  @example Example usage

    Encode and decode a string

      $encodestring = base64('encode', 'thestring')
      $decodestring = base64('decode', 'dGhlc3RyaW5n')

    Explicitly define encode/decode method: default, strict, urlsafe

      $method = 'default'
      $encodestring = base64('encode', 'thestring', $method)
      $decodestring = base64('decode', 'dGhlc3RyaW5n', $method)

    Encode a string as if it was binary

     $encodestring = String(Binary('thestring', '%s'))

    Decode a Binary assuming it is an UTF-8 String

     $decodestring = String(Binary("dGhlc3RyaW5n"), "%s")

  > **Note:*
      Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings.
      See the `new()` function for the Binary and String types for documentation. Also see `binary_file()`
      function for reading a file with binary (non UTF-8) content.

  @return [String] The encoded/decoded value
  DOC

  require 'base64'

  raise Puppet::ParseError, "base64(): Wrong number of arguments (#{args.length}; must be >= 2)" unless args.length >= 2

  actions = ['encode', 'decode']

  unless actions.include?(args[0])
    raise Puppet::ParseError, "base64(): the first argument must be one of 'encode' or 'decode'"
  end

  unless args[1].is_a?(String)
    raise Puppet::ParseError, 'base64(): the second argument must be a string to base64'
  end

  method = ['default', 'strict', 'urlsafe']

  chosen_method = if args.length <= 2
                    'default'
                  else
                    args[2]
                  end

  unless method.include?(chosen_method)
    raise Puppet::ParseError, "base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'"
  end

  case args[0]
  when 'encode'
    case chosen_method
    when 'default'
      result = Base64.encode64(args[1])
    when 'strict'
      result = Base64.strict_encode64(args[1])
    when 'urlsafe'
      result = Base64.urlsafe_encode64(args[1])
    end
  when 'decode'
    case chosen_method
    when 'default'
      result = Base64.decode64(args[1])
    when 'strict'
      result = Base64.strict_decode64(args[1])
    when 'urlsafe'
      result = Base64.urlsafe_decode64(args[1])
    end
  end

  return result
end