openresty/set-misc-nginx-module openresty/set-misc-nginx-module

  • Stars
    star
    388
  • Rank 110,734 (Top 3 %)
  • Language
    C
  • Created almost 15 years ago
  • Updated 4 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
openresty/set-misc-nginx-module
github

openresty

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)

Name

ngx_set_misc - Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)

This module is not distributed with the Nginx source. See the installation instructions.

Table of Contents

Version

This document describes ngx_set_misc v0.32 released on 19 April 2018.

Synopsis

 location /foo {
     set $a $arg_a;
     set_if_empty $a 56;

     # GET /foo?a=32 will yield $a == 32
     # while GET /foo and GET /foo?a= will
     # yeild $a == 56 here.
 }

 location /bar {
     set $foo "hello\n\n'\"\\";
     set_quote_sql_str $foo $foo; # for mysql

     # OR in-place editing:
     #   set_quote_sql_str $foo;

     # now $foo is: 'hello\n\n\'\"\\'
 }

 location /bar {
     set $foo "hello\n\n'\"\\";
     set_quote_pgsql_str $foo;  # for PostgreSQL

     # now $foo is: E'hello\n\n\'\"\\'
 }

 location /json {
     set $foo "hello\n\n'\"\\";
     set_quote_json_str $foo $foo;

     # OR in-place editing:
     #   set_quote_json_str $foo;

     # now $foo is: "hello\n\n'\"\\"
 }

 location /baz {
     set $foo "hello%20world";
     set_unescape_uri $foo $foo;

     # OR in-place editing:
     #   set_unescape_uri $foo;

     # now $foo is: hello world
 }

 upstream_list universe moon sun earth;
 upstream moon { ... }
 upstream sun { ... }
 upstream earth { ... }
 location /foo {
     set_hashed_upstream $backend universe $arg_id;
     drizzle_pass $backend; # used with ngx_drizzle
 }

 location /base32 {
     set $a 'abcde';
     set_encode_base32 $a;
     set_decode_base32 $b $a;

     # now $a == 'c5h66p35' and
     # $b == 'abcde'
 }

 location /base64 {
     set $a 'abcde';
     set_encode_base64 $a;
     set_decode_base64 $b $a;

     # now $a == 'YWJjZGU=' and
     # $b == 'abcde'
 }

 location /hex {
     set $a 'abcde';
     set_encode_hex $a;
     set_decode_hex $b $a;

     # now $a == '6162636465' and
     # $b == 'abcde'
 }

 # GET /sha1 yields the output
 #   aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d
 location /sha1 {
     set_sha1 $a hello;
     echo $a;
 }

 # ditto
 location /sha1 {
     set $a hello;
     set_sha1 $a;
     echo $a;
 }

 # GET /today yields the date of today in local time using format 'yyyy-mm-dd'
 location /today {
     set_local_today $today;
     echo $today;
 }

 # GET /signature yields the hmac-sha-1 signature
 # given a secret and a string to sign
 # this example yields the base64 encoded singature which is
 # "HkADYytcoQQzqbjQX33k/ZBB/DQ="
 location /signature {
     set $secret_key 'secret-key';
     set $string_to_sign "some-string-to-sign";
     set_hmac_sha1 $signature $secret_key $string_to_sign;
     set_encode_base64 $signature $signature;
     echo $signature;
 }

 location = /rand {
     set $from 3;
     set $to 15;
     set_random $rand $from $to;

     # or write directly
     #   set_random $rand 3 15;

     echo $rand;  # will print a random integer in the range [3, 15]
 }

Description

This module extends the standard HttpRewriteModule's directive set to provide more functionalities like URI escaping and unescaping, JSON quoting, Hexadecimal/MD5/SHA1/Base32/Base64 digest encoding and decoding, random number generator, and more!

Every directive provided by this module can be mixed freely with other ngx_http_rewrite_module's directives, like if and set. (Thanks to the Nginx Devel Kit!)

Back to TOC

Directives

Back to TOC

set_if_empty

syntax: set_if_empty $dst <src>

default: no

context: location, location if

phase: rewrite

Assign the value of the argument <src> if and only if variable $dst is empty (i.e., not found or has an empty string value).

In the following example,

 set $a 32;
 set_if_empty $a 56;

the variable $dst will take the value 32 at last. But in the sample

 set $a '';
 set $value "hello, world"
 set_if_empty $a $value;

$a will take the value "hello, world" at last.

Back to TOC

set_quote_sql_str

syntax: set_quote_sql_str $dst <src>

syntax: set_quote_sql_str $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will quote the value of the second argument <src> by MySQL's string value quoting rule and assign the result into the first argument, variable $dst. For example,

 location /test {
     set $value "hello\n\r'\"\\";
     set_quote_sql_str $quoted $value;

     echo $quoted;
 }

Then request GET /test will yield the following output

 'hello\n\r\'\"\\'

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $value "hello\n\r'\"\\";
     set_quote_sql_str $value;

     echo $value;
 }

then request GET /test will give exactly the same output as the previous example.

This directive is usually used to prevent SQL injection.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_quote_pgsql_str

syntax: set_quote_pgsql_str $dst <src>

syntax: set_quote_pgsql_str $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

Very much like set_quote_sql_str, but with PostgreSQL quoting rules for SQL string literals.

Back to TOC

set_quote_json_str

syntax: set_quote_json_str $dst <src>

syntax: set_quote_json_str $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will quote the value of the second argument <src> by JSON string value quoting rule and assign the result into the first argument, variable $dst. For example,

 location /test {
     set $value "hello\n\r'\"\\";
     set_quote_json_str $quoted $value;

     echo $quoted;
 }

Then request GET /test will yield the following output

 "hello\n\r'\"\\"

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $value "hello\n\r'\"\\";
     set_quote_json_str $value;

     echo $value;
 }

then request GET /test will give exactly the same output as the previous example.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_unescape_uri

syntax: set_unescape_uri $dst <src>

syntax: set_unescape_uri $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will unescape the value of the second argument <src> as a URI component and assign the result into the first argument, variable $dst. For example,

 location /test {
     set_unescape_uri $key $arg_key;
     echo $key;
 }

Then request GET /test?key=hello+world%21 will yield the following output

hello world!

The nginx standard $arg_PARAMETER variable holds the raw (escaped) value of the URI parameter. So we need the set_unescape_uri directive to unescape it first.

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $key $arg_key;
     set_unescape_uri $key;

     echo $key;
 }

then request GET /test?key=hello+world%21 will give exactly the same output as the previous example.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_escape_uri

syntax: set_escape_uri $dst <src>

syntax: set_escape_uri $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

Very much like the set_unescape_uri directive, but does the conversion the other way around, i.e., URL component escaping.

Back to TOC

set_hashed_upstream

syntax: set_hashed_upstream $dst <upstream_list_name> <src>

default: no

context: location, location if

phase: rewrite

Hashes the string argument <src> into one of the upstream name included in the upstream list named <upstream_list_name>. The hash function being used is simple modulo.

Here's an example,

 upstream moon { ... }
 upstream sun { ... }
 upstream earth { ... }

 upstream_list universe moon sun earth;

 location /test {
     set_unescape_uri $key $arg_key;
     set $list_name universe;
     set_hashed_upstream $backend $list_name $key;

     echo $backend;
 }

Then GET /test?key=blah will output either "moon", "sun", or "earth", depending on the actual value of the key query argument.

This directive is usually used to compute an nginx variable to be passed to memc-nginx-module's memc_pass directive, redis2-nginx-module's [[HttpRedis2Module#redis2_pass]] directive, and ngx_http_proxy_module's proxy_pass directive, among others.

Back to TOC

set_encode_base32

syntax: set_encode_base32 $dst <src>

syntax: set_encode_base32 $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument <src> to its base32(hex) digest and assign the result into the first argument, variable $dst. For example,

 location /test {
     set $raw "abcde";
     set_encode_base32 $digest $raw;

     echo $digest;
 }

Then request GET /test will yield the following output

c5h66p35

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

RFC forces the [A-Z2-7] RFC-3548 compliant encoding, but we are using the "base32hex" encoding ([0-9a-v]) by default. The set_base32_alphabet directive (first introduced in v0.28) allows you to change the alphabet used for encoding/decoding so RFC-3548 compliant encoding is still possible by custom configurations.

By default, the = character is used to pad the left-over bytes due to alignment. But the padding behavior can be completely disabled by setting set_base32_padding off.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $value "abcde";
     set_encode_base32 $value;

     echo $value;
 }

then request GET /test will give exactly the same output as the previous example.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_base32_padding

syntax: set_base32_padding on|off

default: on

context: http, server, server if, location, location if

phase: no

This directive can control whether to pad left-over bytes with the "=" character when encoding a base32 digest by the set_encode_base32 directive.

This directive was first introduced in v0.28. If you use earlier versions of this module, then you should use set_misc_base32_padding instead.

Back to TOC

set_misc_base32_padding

syntax: set_misc_base32_padding on|off

default: on

context: http, server, server if, location, location if

phase: no

This directive has been deprecated since v0.28. Use set_base32_padding instead if you are using v0.28+.

Back to TOC

set_base32_alphabet

syntax: set_base32_alphabet <alphabet>

default: "0123456789abcdefghijklmnopqrstuv"

context: http, server, server if, location, location if

phase: no

This directive controls the alphabet used for encoding/decoding a base32 digest. It accepts a string containing the desired alphabet like "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567" for standard alphabet.

Extended (base32hex) alphabet is used by default.

This directive was first introduced in v0.28.

Back to TOC

set_decode_base32

syntax: set_decode_base32 $dst <src>

syntax: set_decode_base32 $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

Similar to the set_encode_base32 directive, but does exactly the opposite operation, .i.e, decoding a base32(hex) digest into its original form.

Back to TOC

set_encode_base64

syntax: set_encode_base64 $dst <src>

syntax: set_encode_base64 $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument <src> to its base64 digest and assign the result into the first argument, variable $dst. For example,

 location /test {
     set $raw "abcde";
     set_encode_base64 $digest $raw;

     echo $digest;
 }

Then request GET /test will yield the following output

YWJjZGU=

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $value "abcde";
     set_encode_base64 $value;

     echo $value;
 }

then request GET /test will give exactly the same output as the previous example.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_encode_base64url

syntax: set_encode_base64url $dst <src>

syntax: set_encode_base64url $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument <src> to its base64 url safe digest and assign the result into the first argument, variable $dst. For example,

 location /test {
     set $raw "abcde";
     set_encode_base64url $digest $raw;

     echo $digest;
 }

Then request GET /test will yield the following output

YWJjZGU=

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $value "abcde";
     set_encode_base64url $value;

     echo $value;
 }

then request GET /test will give exactly the same output as the previous example.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_decode_base64

syntax: set_decode_base64 $dst <src>

syntax: set_decode_base64 $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

Similar to the set_encode_base64 directive, but does exactly the opposite operation, .i.e, decoding a base64 digest into its original form.

Back to TOC

set_decode_base64url

syntax: set_decode_base64url $dst <src>

syntax: set_decode_base64url $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

Similar to the set_encode_base64url directive, but does exactly the the opposite operation, .i.e, decoding a base64 url safe digest into its original form.

Back to TOC

set_encode_hex

syntax: set_encode_hex $dst <src>

syntax: set_encode_hex $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument <src> to its hexadecimal digest and assign the result into the first argument, variable $dst. For example,

 location /test {
     set $raw "章亦春";
     set_encode_hex $digest $raw;

     echo $digest;
 }

Then request GET /test will yield the following output

e7aba0e4baa6e698a5

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $value "章亦春";
     set_encode_hex $value;

     echo $value;
 }

then request GET /test will give exactly the same output as the previous example.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_decode_hex

syntax: set_decode_hex $dst <src>

syntax: set_decode_hex $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

Similar to the set_encode_hex directive, but does exactly the opposite operation, .i.e, decoding a hexadecimal digest into its original form.

Back to TOC

set_sha1

syntax: set_sha1 $dst <src>

syntax: set_sha1 $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument <src> to its SHA-1 digest and assign the result into the first argument, variable $dst. The hexadecimal form of the SHA-1 digest will be generated automatically, use set_decode_hex to decode the result if you want the binary form of the SHA-1 digest.

For example,

 location /test {
     set $raw "hello";
     set_sha1 $digest $raw;

     echo $digest;
 }

Then request GET /test will yield the following output

aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $value "hello";
     set_sha1 $value;

     echo $value;
 }

then request GET /test will give exactly the same output as the previous example.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_md5

syntax: set_md5 $dst <src>

syntax: set_md5 $dst

default: no

context: location, location if

phase: rewrite

category: ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument <src> to its MD5 digest and assign the result into the first argument, variable $dst. The hexadecimal form of the MD5 digest will be generated automatically, use set_decode_hex to decode the result if you want the binary form of the MD5 digest.

For example,

 location /test {
     set $raw "hello";
     set_md5 $digest $raw;

     echo $digest;
 }

Then request GET /test will yield the following output

5d41402abc4b2a76b9719d911017c592

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

 location /test {
     set $value "hello";
     set_md5 $value;

     echo $value;
 }

then request GET /test will give exactly the same output as the previous example.

This directive can be invoked by lua-nginx-module's ndk.set_var.DIRECTIVE interface and array-var-nginx-module's array_map_op directive.

Back to TOC

set_hmac_sha1

syntax: set_hmac_sha1 $dst <secret_key> <src>

syntax: set_hmac_sha1 $dst

default: no

context: location, location if

phase: rewrite

Computes the HMAC-SHA1 digest of the argument <src> and assigns the result into the argument variable $dst with the secret key <secret_key>.

The raw binary form of the HMAC-SHA1 digest will be generated, use set_encode_base64, for example, to encode the result to a textual representation if desired.

For example,

 location /test {
     set $secret 'thisisverysecretstuff';
     set $string_to_sign 'some string we want to sign';
     set_hmac_sha1 $signature $secret $string_to_sign;
     set_encode_base64 $signature $signature;
     echo $signature;
 }

Then request GET /test will yield the following output

R/pvxzHC4NLtj7S+kXFg/NePTmk=

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

This directive requires the OpenSSL library enabled in your Nginx build (usually by passing the --with-http_ssl_module option to the ./configure script).

Back to TOC

set_hmac_sha256

syntax: set_hmac_sha256 $dst <secret_key> <src>

syntax: set_hmac_sha256 $dst

default: no

context: location, location if

phase: rewrite

Computes the HMAC-SHA256 digest of the argument <src> and assigns the result into the argument variable $dst with the secret key <secret_key>.

The raw binary form of the HMAC-SHA256 digest will be generated, use set_encode_base64, for example, to encode the result to a textual representation if desired.

For example,

 location /test {
     set $secret 'thisisverysecretstuff';
     set $string_to_sign 'some string we want to sign';
     set_hmac_sha256 $signature $secret $string_to_sign;
     set_encode_base64 $signature $signature;
     echo $signature;
 }

Then request GET /test will yield the following output

4pU3GRQrKKIoeLb9CqYsavHE2l6Hx+KMmRmesU+Cfrs=

Please note that we're using echo-nginx-module's echo directive here to output values of nginx variables directly.

This directive requires the OpenSSL library enabled in your Nginx build (usually by passing the --with-http_ssl_module option to the ./configure script).

Back to TOC

set_random

syntax: set_random $res <from> <to>

default: no

context: location, location if

phase: rewrite

Generates a (pseudo) random number (in textual form) within the range [<$from>, <$to>] (inclusive).

Only non-negative numbers are allowed for the <from> and <to> arguments.

When <from> is greater than <to>, their values will be exchanged accordingly.

For instance,

 location /test {
     set $from 5;
     set $to 7;
     set_random $res $from $to;

     echo $res;
 }

then request GET /test will output a number between 5 and 7 (i.e., among 5, 6, 7).

For now, there's no way to configure a custom random generator seed.

Behind the scene, it makes use of the standard C function rand().

This directive was first introduced in the v0.22rc1 release.

See also set_secure_random_alphanum and set_secure_random_lcalpha.

Back to TOC

set_secure_random_alphanum

syntax: set_secure_random_alphanum $res <length>

default: no

context: location, location if

phase: rewrite

Generates a cryptographically-strong random string <length> characters long with the alphabet [a-zA-Z0-9].

<length> may be between 1 and 64, inclusive.

For instance,

 location /test {
     set_secure_random_alphanum $res 32;

     echo $res;
 }

then request GET /test will output a string like ivVVRP2DGaAqDmdf3Rv4ZDJ7k0gOfASz.

This functionality depends on the presence of the /dev/urandom device, available on most UNIX-like systems.

See also set_secure_random_lcalpha and set_random.

This directive was first introduced in the v0.22rc8 release.

Back to TOC

set_secure_random_lcalpha

syntax: set_secure_random_lcalpha $res <length>

default: no

context: location, location if

phase: rewrite

Generates a cryptographically-strong random string <length> characters long with the alphabet [a-z].

<length> may be between 1 and 64, inclusive.

For instance,

 location /test {
     set_secure_random_lcalpha $res 32;

     echo $res;
 }

then request GET /test will output a string like kcuxcddktffsippuekhshdaclaquiusj.

This functionality depends on the presence of the /dev/urandom device, available on most UNIX-like systems.

This directive was first introduced in the v0.22rc8 release.

See also set_secure_random_alphanum and set_random.

Back to TOC

set_rotate

syntax: set_rotate $value <from> <to>

default: no

context: location, location if

phase: rewrite

Increments $value but keeps it in range from <from> to <to>. If $value is greater than <to> or less than <from> is will be set to <from> value.

The current value after running this directive will always be saved on a per-location basis. And the this saved value will be used for incrementation when the $value is not initialized or has a bad value.

Only non-negative numbers are allowed for the <from> and <to> arguments.

When <from> is greater than <to>, their values will be exchanged accordingly.

For instance,

 location /rotate {
     default_type text/plain;
     set $counter $cookie_counter;
     set_rotate $counter 1 5;
     echo $counter;
     add_header Set-Cookie counter=$counter;
 }

then request GET /rotate will output next number between 1 and 5 (i.e., 1, 2, 3, 4, 5) on each refresh of the page. This directive may be userful for banner rotation purposes.

Another example is to use server-side value persistence to do simple round-robin:

 location /rotate {
     default_type text/plain;
     set_rotate $counter 0 3;
     echo $counter;
 }

And accessing /rotate will also output integer sequence 0, 1, 2, 3, 0, 1, 2, 3, and so on.

This directive was first introduced in the v0.22rc7 release.

Back to TOC

set_local_today

syntax: set_local_today $dst

default: no

context: location, location if

phase: rewrite

Set today's date ("yyyy-mm-dd") in localtime to the argument variable $dst.

Here's an example,

 location /today {
     set_local_today $today;
     echo $today;
 }

then request GET /today will output something like

2011-08-16

and year, the actual date you get here will vary every day ;)

Behind the scene, this directive utilizes the ngx_time API in the Nginx core, so usually no syscall is involved due to the time caching mechanism in the Nginx core.

Back to TOC

set_formatted_gmt_time

syntax: set_formatted_gmt_time $res <time-format>

default: no

context: location, location if

phase: rewrite

Set a formatted GMT time to variable $res (as the first argument) using the format string in the second argument.

All the conversion specification notations in the standard C function strftime are supported, like %Y (for 4-digit years) and %M (for minutes in decimal). See http://linux.die.net/man/3/strftime for a complete list of conversion specification symbols.

Below is an example:

 location = /t {
     set_formatted_gmt_time $timestr "%a %b %e %H:%M:%S %Y GMT";
     echo $timestr;
 }

Accessing /t yields the output

Fri Dec 13 15:34:37 2013 GMT

This directive was first added in the 0.23 release.

See also set_formatted_local_time.

Back to TOC

set_formatted_local_time

syntax: set_formatted_local_time $res <time-format>

default: no

context: location, location if

phase: rewrite

Set a formatted local time to variable $res (as the first argument) using the format string in the second argument.

All the conversion specification notations in the standard C function strftime are supported, like %Y (for 4-digit years) and %M (for minutes in decimal). See http://linux.die.net/man/3/strftime for a complete list of conversion specification symbols.

Below is an example:

 location = /t {
     set_formatted_local_time $timestr "%a %b %e %H:%M:%S %Y %Z";
     echo $timestr;
 }

Accessing /t yields the output

Fri Dec 13 15:42:15 2013 PST

This directive was first added in the 0.23 release.

See also set_formatted_gmt_time.

Back to TOC

Caveats

Do not use $arg_PARAMETER, $cookie_COOKIE, $http_HEADER or other special variables defined in the Nginx core module as the target variable in this module's directives. For instance,

 set_if_empty $arg_user 'foo';  # DO NOT USE THIS!

may lead to segmentation faults.

Back to TOC

Installation

This module is included and enabled by default in the OpenResty bundle. If you want to install this module manually with your own Nginx source tarball, then follow the steps below:

Grab the nginx source code from nginx.org, for example, the version 1.13.6 (see nginx compatibility), and then build the source with this module:

 wget 'http://nginx.org/download/nginx-1.13.6.tar.gz'
 tar -xzvf nginx-1.13.6.tar.gz
 cd nginx-1.13.6/

 # Here we assume you would install you nginx under /opt/nginx/.
 ./configure --prefix=/opt/nginx \
     --with-http_ssl_module \
     --add-module=/path/to/ngx_devel_kit \
     --add-module=/path/to/set-misc-nginx-module

 make -j2
 make install

Download the latest version of the release tarball of this module from set-misc-nginx-module file list, and the latest tarball for ngx_devel_kit from its file list.

Back to TOC

Building as a dynamic module

Starting from NGINX 1.9.11, you can also compile this module as a dynamic module, by using the --add-dynamic-module=PATH option instead of --add-module=PATH on the ./configure command line above. And then you can explicitly load the module in your nginx.conf via the load_module directive, for example,

load_module /path/to/modules/ndk_http_module.so;  # assuming NDK is built as a dynamic module too
load_module /path/to/modules/ngx_http_set_misc_module.so;

Also, this module is included and enabled by default in the OpenResty bundle.

Back to TOC

Compatibility

The following versions of Nginx should work with this module:

  • 1.13.x (last tested: 1.13.6)
  • 1.12.x
  • 1.11.x (last tested: 1.11.2)
  • 1.10.x
  • 1.9.x (last tested: 1.9.15)
  • 1.8.x
  • 1.7.x (last tested: 1.7.10)
  • 1.6.x
  • 1.5.x (last tested: 1.5.8)
  • 1.4.x (last tested: 1.4.4)
  • 1.2.x (last tested: 1.2.9)
  • 1.1.x (last tested: 1.1.5)
  • 1.0.x (last tested: 1.0.15)
  • 0.9.x (last tested: 0.9.4)
  • 0.8.x (last tested: 0.8.54)
  • 0.7.x >= 0.7.46 (last tested: 0.7.68)

If you find that any particular version of Nginx above 0.7.46 does not work with this module, please consider reporting a bug.

Back to TOC

Report Bugs

Although a lot of effort has been put into testing and code tuning, there must be some serious bugs lurking somewhere in this module. So whenever you are bitten by any quirks, please don't hesitate to

  1. send a bug report or even patches to the openresty-en mailing list,
  2. or create a ticket on the issue tracking interface provided by GitHub.

Back to TOC

Source Repository

Available on github at openresty/set-misc-nginx-module.

Back to TOC

Changes

The change logs for every release of this module can be obtained from the OpenResty bundle's change logs:

http://openresty.org/#Changes

Back to TOC

Test Suite

This module comes with a Perl-driven test suite. The test cases are declarative too. Thanks to the Test::Nginx module in the Perl world.

To run it on your side:

 $ PATH=/path/to/your/nginx-with-set-misc-module:$PATH prove -r t

You need to terminate any Nginx processes before running the test suite if you have changed the Nginx server binary.

Because a single nginx server (by default, localhost:1984) is used across all the test scripts (.t files), it's meaningless to run the test suite in parallel by specifying -jN when invoking the prove utility.

Back to TOC

Getting involved

You'll be very welcomed to submit patches to the author or just ask for a commit bit to the source repository on GitHub.

Back to TOC

Author

Yichun Zhang (agentzh) <[email protected]>, OpenResty Inc.

This wiki page is also maintained by the author himself, and everybody is encouraged to improve this page as well.

Back to TOC

Copyright & License

Copyright (C) 2009-2018, Yichun Zhang (章亦春) [email protected], OpenResty Inc.

This module is licensed under the terms of the BSD license.

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

Back to TOC

More Repositories

1

openresty

High Performance Web Platform Based on Nginx and LuaJIT
C
12,431
star
2

lua-nginx-module

Embed the Power of Lua into NGINX HTTP servers
C
11,224
star
3

nginx-tutorials

Nginx Tutorials
Perl
2,864
star
4

lua-resty-redis

Lua redis client driver for the ngx_lua based on the cosocket API
Lua
1,893
star
5

openresty-systemtap-toolkit

Real-time analysis and diagnostics tools for OpenResty (including NGINX, LuaJIT, ngx_lua, and more) based on SystemTap
Perl
1,653
star
6

headers-more-nginx-module

Set, add, and clear arbitrary output headers in NGINX http servers
C
1,636
star
7

openresty.org

Code and data for the openresty.org site
HTML
1,262
star
8

luajit2

OpenResty's Branch of LuaJIT 2
C
1,229
star
9

echo-nginx-module

An Nginx module for bringing the power of "echo", "sleep", "time" and more to Nginx's config file
C
1,162
star
10

docker-openresty

Docker tooling for OpenResty
Dockerfile
934
star
11

redis2-nginx-module

Nginx upstream module for the Redis 2.0 protocol
C
902
star
12

lua-resty-limit-traffic

Lua library for limiting and controlling traffic in OpenResty/ngx_lua
Lua
815
star
13

lua-resty-core

New FFI-based API for lua-nginx-module
Lua
797
star
14

stream-lua-nginx-module

Embed the power of Lua into NGINX TCP/UDP servers
C
723
star
15

lua-resty-mysql

Nonblocking Lua MySQL driver library for ngx_lua or OpenResty
Lua
703
star
16

stapxx

Simple macro language extentions to systemtap
Perl
692
star
17

sregex

A non-backtracking NFA/DFA-based Perl-compatible regex engine matching on large data streams
C
616
star
18

lua-resty-upstream-healthcheck

Health Checker for Nginx Upstream Servers in Pure Lua
Lua
513
star
19

lua-resty-websocket

WebSocket support for the ngx_lua module (and OpenResty)
Lua
503
star
20

lua-upstream-nginx-module

Nginx C module to expose Lua API to ngx_lua for Nginx upstreams
C
499
star
21

srcache-nginx-module

Transparent subrequest-based caching layout for arbitrary nginx locations.
C
474
star
22

opm

OpenResty Package Manager
Lua
458
star
23

test-nginx

Data-driven test scaffold for Nginx C module and OpenResty Lua library development
Perl
438
star
24

lua-resty-lrucache

Lua-land LRU Cache based on LuaJIT FFI
Lua
437
star
25

lua-resty-string

String utilities and common hash functions for ngx_lua and LuaJIT
Lua
426
star
26

lua-resty-upload

Streaming reader and parser for http file uploading based on ngx_lua cosocket
Lua
401
star
27

drizzle-nginx-module

an nginx upstream module that talks to mysql and drizzle by libdrizzle
C
336
star
28

openresty-gdb-utils

GDB Utilities for OpenResty (including Nginx, ngx_lua, LuaJIT, and more)
Python
335
star
29

lua-resty-balancer

A generic consistent hash implementation for OpenResty/Lua
Lua
325
star
30

lua-resty-dns

DNS resolver for the nginx lua module
Lua
321
star
31

programming-openresty

Programming OpenResty Book
Perl
317
star
32

lua-resty-lock

Simple nonblocking lock API for ngx_lua based on shared memory dictionaries
Lua
304
star
33

openresty-devel-utils

Utilities for nginx module development
Perl
266
star
34

resty-cli

Fancy command-line utilities for OpenResty
Perl
263
star
35

replace-filter-nginx-module

Streaming regular expression replacement in response bodies
C
258
star
36

memc-nginx-module

An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.
C
213
star
37

lua-resty-memcached

Lua memcached client driver for the ngx_lua based on the cosocket API
Lua
210
star
38

encrypted-session-nginx-module

encrypt and decrypt nginx variable values
C
198
star
39

openresty-packaging

Official OpenResty packaging source and scripts for various Linux distributions and other systems
Makefile
176
star
40

rds-json-nginx-module

An nginx output filter that formats Resty DBD Streams generated by ngx_drizzle and others to JSON
C
153
star
41

xss-nginx-module

Native support for cross-site scripting (XSS) in an nginx
C
148
star
42

mockeagain

Mocking ideally slow network that only allows reading and/or writing one byte at a time
C
129
star
43

lua-resty-shell

Lua module for nonblocking system shell command executions
Perl
124
star
44

lua-tablepool

Lua table recycling pools for LuaJIT
Perl
112
star
45

lua-redis-parser

Lua module for parsing raw redis responses
C
93
star
46

openresty-survey

OpenResty Web App for OpenResty User Survey
HTML
90
star
47

lua-ssl-nginx-module

NGINX C module that extends ngx_http_lua_module for enhanced SSL/TLS capabilities
Lua
86
star
48

opsboy

A rule-based sysadmin tool that helps setting up complex environment for blank machines
Perl
85
star
49

no-pool-nginx

replace nginx's pool mechanism with plain malloc & free to help tools like valgrind
Shell
77
star
50

stream-echo-nginx-module

TCP/stream echo module for NGINX (a port of ngx_http_echo_module)
C
69
star
51

meta-lua-nginx-module

Meta Lua Nginx Module supporting both Http Lua Module and Stream Lua Module
C
66
star
52

array-var-nginx-module

Add support for array-typed variables to nginx config files
C
66
star
53

lemplate

OpenResty/Lua template framework implementing Perl's TT2 templating language
Perl
54
star
54

openresty-con

JavaScript
48
star
55

nginx-dtrace

An nginx fork that adds dtrace USDT probes
C
44
star
56

orbpf-ko

The orbpf (eBPF+) Linux kernel module from OpenResty Inc.
C
37
star
57

lua-resty-memcached-shdict

Powerful memcached client with a shdict caching layer and many other features
Lua
33
star
58

lua-resty-signal

Lua library for killing or sending signals to UNIX processes
Perl
32
star
59

lua-resty-shdict-simple

Simple applicaton-oriented interface to the OpenResty shared dictionary API
Perl
32
star
60

luajit2-test-suite

OpenResty's LuaJIT test suite based on Mike Pall's LuaJIT tests
Lua
29
star
61

ngx_postgres

OpenResty's fork of FRiCKLE/ngx_postgres
C
26
star
62

rds-csv-nginx-module

Nginx output filter module to convert Resty-DBD-Streams (RDS) to Comma-Separated Values (CSV)
C
22
star
63

showman-samples

Sample screenplay files for generating our public video tutorials using OpenResty Showman
20
star
64

lua-rds-parser

Resty DBD Stream (RDS) parser for Lua written in C
C
19
star
65

redis-nginx-module

8
star
66

AB-test-http

test http requests between two systems.
Perl
5
star
67

transparency

2
star