Name

ngx.base64 - urlsafe base64 encode/decode functions OpenResty/ngx_lua.

Table of Contents

• Name
• Status
• Synopsis
• Methods
  • encode_base64url
  • decode_base64url
• Community
  • English Mailing List
  • Chinese Mailing List
• Bugs and Patches
• Author
• Copyright and License
• See Also

Status

This Lua module is production ready.

Synopsis

local b64 = require("ngx.base64")
local res, err

res = b64.encode_base64url("foo")

res, err = b64.decode_base64url(res)
if not res then
    -- invalid input
    ngx.log(ngx.ERR, err)
end

assert(res == "foo")

Back to TOC

Methods

encode_base64url

syntax: encoded = base64.encode_base64url(input)

context: any

Encode input using base64url rules. Returns the encoded string.

Back to TOC

decode_base64url

syntax: decoded, err = base64.decode_base64url(input)

context: any

Decode input using base64url rules. Returns the decoded string.

If the input is not a valid base64url encoded string, decodedwill be nil and err will be a string describing the error.

Back to TOC

Community

Back to TOC

English Mailing List

The openresty-en mailing list is for English speakers.

Back to TOC

Chinese Mailing List

The openresty mailing list is for Chinese speakers.

Back to TOC

Bugs and Patches

Please report bugs or submit patches by

1. creating a ticket on the GitHub Issue Tracker,
2. or posting to the OpenResty community.

Back to TOC

Author

Datong Sun <datong@openresty.com> (dndx), OpenResty Inc.

Back to TOC

Copyright and License

This module is licensed under the BSD license.

Copyright (C) 2017, by Yichun “agentzh” Zhang, OpenResty Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC

See Also

• the lua-resty-core library.
• the ngx_lua module: https://github.com/openresty/lua-nginx-module
• OpenResty: https://openresty.org

Back to TOC

Last updated: 3 years ago | Edit on GitHub