Skip to content

Instantly share code, notes, and snippets.

@petarbojic

petarbojic/README.md

Forked from stokito/README.md
Created June 29, 2025 14:57
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save petarbojic/c33a4d45e1b4d078f68371351633ee38 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save petarbojic/c33a4d45e1b4d078f68371351633ee38 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @stokito stokito revised this gist Sep 7, 2023. 1 changed file with 3 additions and 1 deletion.
    4 changes: 3 additions & 1 deletion README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -45,4 +45,6 @@ Also there is and example of shell script to process File Upload [httpd_post_upl
    * https://git.zx2c4.com/cgit/tree/README cgit
    * https://github.com/OpenPrinting/cups/tree/master/cgi-bin CUPS printing
    * [date.cgi](https://gist.github.com/stokito/4a145d73402946ba6ec8d3a3ca83e1ae)
    * [echo.cgi](https://gist.github.com/stokito/5b22a58573360ef2daf0b01463505bc6)
    * [echo.cgi](https://gist.github.com/stokito/5b22a58573360ef2daf0b01463505bc6)
    * [Directory listing script](https://gist.github.com/jow-/743363c332d09cb58a60dd1f216b6ee4) in Perl
    * [print envs](https://gist.github.com/yukioc/950081) in Python
  2. @stokito stokito revised this gist May 15, 2023. 1 changed file with 21 additions and 0 deletions.
    21 changes: 21 additions & 0 deletions edit_file.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,21 @@
    #!/bin/sh
    # Imitation of webdav to read and edit a file
    if [ "$REMOTE_USER" != "admin" ]; then
    printf "Status: 403\r\n"
    printf "\r\n"
    printf "Only admin can change users but you are %s" "$REMOTE_USER"
    exit
    fi

    if [ "$REQUEST_METHOD" = "GET" ]; then
    printf "Content-Type: text/plain\r\n"
    printf "\r\n"
    cat /etc/hosts
    elif [ "$REQUEST_METHOD" = "PUT" ]; then
    CONTENT=$(cat -)
    printf "%s" "$CONTENT" > /etc/hosts
    printf "Status: 204\r\n"
    printf "\r\n"
    else
    printf "Status: 405\r\n"
    fi
  3. @stokito stokito revised this gist May 14, 2023. 1 changed file with 19 additions and 19 deletions.
    38 changes: 19 additions & 19 deletions echo.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -3,33 +3,33 @@
    CONTENT=$(cat -)
    printf "Content-Length: ${#CONTENT}\r\n"
    printf "Content-Type: text/html\r\n"
    printf "REQUEST_METHOD: \"$REQUEST_METHOD\"\r\n"
    printf "CONTENT_TYPE: \"$CONTENT_TYPE\"\r\n"
    printf "CONTENT_LENGTH: \"$CONTENT_LENGTH\"\r\n"
    printf "ENV_REQUEST_METHOD: \"$REQUEST_METHOD\"\r\n"
    printf "ENV_CONTENT_TYPE: \"$CONTENT_TYPE\"\r\n"
    printf "ENV_CONTENT_LENGTH: \"$CONTENT_LENGTH\"\r\n"

    printf "REMOTE_ADDR: \"$REMOTE_ADDR\"\r\n"
    printf "REMOTE_PORT: \"$REMOTE_PORT\"\r\n"
    printf "SERVER_PORT: \"$SERVER_PORT\"\r\n"
    printf "ENV_REMOTE_ADDR: \"$REMOTE_ADDR\"\r\n"
    printf "ENV_REMOTE_PORT: \"$REMOTE_PORT\"\r\n"
    printf "ENV_SERVER_PORT: \"$SERVER_PORT\"\r\n"

    printf "REQUEST_URI: \"$REQUEST_URI\"\r\n"
    printf "QUERY_STRING: \"$QUERY_STRING\"\r\n"
    printf "ENV_REQUEST_URI: \"$REQUEST_URI\"\r\n"
    printf "ENV_QUERY_STRING: \"$QUERY_STRING\"\r\n"

    # all headers from request now available with the HTTP_ prefix
    printf "HTTP_HOST: \"$HTTP_HOST\"\r\n"
    printf "HTTP_USER_AGENT: \"$HTTP_USER_AGENT\"\r\n"
    printf "HTTP_ACCEPT: \"$HTTP_ACCEPT\"\r\n"
    printf "HTTP_REFERER: \"$HTTP_REFERER\"\r\n"
    printf "ENV_HTTP_HOST: \"$HTTP_HOST\"\r\n"
    printf "ENV_HTTP_USER_AGENT: \"$HTTP_USER_AGENT\"\r\n"
    printf "ENV_HTTP_ACCEPT: \"$HTTP_ACCEPT\"\r\n"
    printf "ENV_HTTP_REFERER: \"$HTTP_REFERER\"\r\n"

    # username from basic auth (e.g. without password)
    printf "REMOTE_USER: \"$REMOTE_USER\"\r\n"
    printf "ENV_REMOTE_USER: \"$REMOTE_USER\"\r\n"

    printf "SCRIPT_NAME: \"$SCRIPT_NAME\"\r\n"
    printf "PATH_INFO: \"$PATH_INFO\"\r\n"
    printf "PATH: \"$PATH\"\r\n"
    printf "PWD: \"$PWD\"\r\n"
    printf "ENV_SCRIPT_NAME: \"$SCRIPT_NAME\"\r\n"
    printf "ENV_PATH_INFO: \"$PATH_INFO\"\r\n"
    printf "ENV_PATH: \"$PATH\"\r\n"
    printf "ENV_PWD: \"$PWD\"\r\n"

    printf "SERVER_PROTOCOL: \"$SERVER_PROTOCOL\"\r\n"
    printf "SERVER_SOFTWARE: \"$SERVER_SOFTWARE\"\r\n"
    printf "ENV_SERVER_PROTOCOL: \"$SERVER_PROTOCOL\"\r\n"
    printf "ENV_SERVER_SOFTWARE: \"$SERVER_SOFTWARE\"\r\n"

    printf "\r\n"
    printf "$CONTENT"
  4. @stokito stokito revised this gist May 14, 2023. 2 changed files with 24 additions and 0 deletions.
    12 changes: 12 additions & 0 deletions echo_param.pl
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,12 @@
    #!/usr/bin/perl
    use strict;
    use warnings;

    print "Content-type: text/html\r\n";
    print "\r\n";
    my $name = '';
    if ($ENV{QUERY_STRING}) {
    ($name) = $ENV{QUERY_STRING} =~ /^name=(.*)$/;
    }

    print "Hello $name\n";
    12 changes: 12 additions & 0 deletions hello.py
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,12 @@
    #!/usr/bin/python
    print("Content-type:text/html\r\n")
    print("\r\n")

    print('<html>')
    print('<head>')
    print('<title>Hello from CGI in Python</title>')
    print('</head>')
    print('<body>')
    print('<h1>Hello World!</h2>')
    print('</body>')
    print('</html>')
  5. @stokito stokito revised this gist May 14, 2023. 5 changed files with 27 additions and 14 deletions.
    10 changes: 5 additions & 5 deletions listing.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -1,12 +1,12 @@
    #!/bin/bash
    # list files in a directory. Please not that it needs for Bash
    echo "Content-type: text/html"
    echo ""
    printf "Content-Type: text/html\r\n"
    printf "\r\n"

    echo "<p>List of files in </strong><code>/</code></p>"

    files=($(ls /))

    for file in "${files[@]}"
    do
    echo "<code>$file</code><br>"
    4 changes: 2 additions & 2 deletions printenvs.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,6 @@
    #!/bin/sh
    # print all env variables
    echo "Content-Type: text/html"
    echo ""
    printf "Content-Type: text/plain\r\n"
    printf "\r\n"
    echo "Environment variables:"
    env
    8 changes: 3 additions & 5 deletions redirect.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -1,7 +1,5 @@
    #!/bin/sh
    # Redirect from HTTP to HTTPS
    cat <<EOF
    Status: 302 Redirect
    Location: https://$SERVER_NAME:$SERVER_PORT/
    EOF
    printf "Status: 302 Redirect\r\n"
    printf "Location: https://$SERVER_NAME:$SERVER_PORT/\r\n"
    printf "\r\n"
    15 changes: 15 additions & 0 deletions render_html.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,15 @@
    #!/bin/sh
    printf "Content-Type: text/html\r\n"
    printf "\r\n"
    cat <<EOF
    <!DOCTYPE html>
    <html>
    <head>
    <meta charset="UTF-8">
    <title>CGI render HTML sample</title>
    </head>
    <body>
    <h1>Hello from CGI</h1>
    </body>
    </html>
    EOF
    4 changes: 2 additions & 2 deletions slow.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,5 @@
    #!/bin/sh
    # Slowly read and write back the request
    echo "Content-Type: text/plain"
    echo
    printf "Content-Type: text/plaint\r\n"
    printf "\r\n"
    set | while read line; do echo $line; sleep 1; done
  6. @stokito stokito revised this gist May 11, 2023. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -44,4 +44,5 @@ Also there is and example of shell script to process File Upload [httpd_post_upl
    * https://github.com/ruudud/cgi bash samples
    * https://git.zx2c4.com/cgit/tree/README cgit
    * https://github.com/OpenPrinting/cups/tree/master/cgi-bin CUPS printing
    * [date.cgi](https://gist.github.com/stokito/4a145d73402946ba6ec8d3a3ca83e1ae)
    * [date.cgi](https://gist.github.com/stokito/4a145d73402946ba6ec8d3a3ca83e1ae)
    * [echo.cgi](https://gist.github.com/stokito/5b22a58573360ef2daf0b01463505bc6)
  7. @stokito stokito revised this gist May 11, 2023. 1 changed file with 13 additions and 0 deletions.
    13 changes: 13 additions & 0 deletions listing.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,13 @@
    #!/bin/bash
    # list files in a directory. Please not that it needs for Bash
    echo "Content-type: text/html"
    echo ""

    echo "<p>List of files in </strong><code>/</code></p>"

    files=($(ls /))

    for file in "${files[@]}"
    do
    echo "<code>$file</code><br>"
    done
  8. @stokito stokito revised this gist May 11, 2023. 3 changed files with 4 additions and 2 deletions.
    1 change: 1 addition & 0 deletions printenvs.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,5 @@
    #!/bin/sh
    # print all env variables
    echo "Content-Type: text/html"
    echo ""
    echo "Environment variables:"
    3 changes: 2 additions & 1 deletion redirect.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,7 @@
    #!/bin/sh
    # Redirect from HTTP to HTTPS
    cat <<EOF
    Status: 302 Redirect
    Location: http://$SERVER_NAME:$SERVER_PORT/
    Location: https://$SERVER_NAME:$SERVER_PORT/
    EOF
    2 changes: 1 addition & 1 deletion slow.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,5 @@
    #!/bin/sh
    # GPLv2. From webfs sources
    # Slowly read and write back the request
    echo "Content-Type: text/plain"
    echo
    set | while read line; do echo $line; sleep 1; done
  9. @stokito stokito revised this gist May 11, 2023. 2 changed files with 30 additions and 5 deletions.
    3 changes: 2 additions & 1 deletion README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -43,4 +43,5 @@ Also there is and example of shell script to process File Upload [httpd_post_upl
    * https://github.com/yurt-page/cgi-ubus plain shell
    * https://github.com/ruudud/cgi bash samples
    * https://git.zx2c4.com/cgit/tree/README cgit
    * https://github.com/OpenPrinting/cups/tree/master/cgi-bin CUPS printing
    * https://github.com/OpenPrinting/cups/tree/master/cgi-bin CUPS printing
    * [date.cgi](https://gist.github.com/stokito/4a145d73402946ba6ec8d3a3ca83e1ae)
    32 changes: 28 additions & 4 deletions echo.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -3,9 +3,33 @@
    CONTENT=$(cat -)
    printf "Content-Length: ${#CONTENT}\r\n"
    printf "Content-Type: text/html\r\n"
    printf "REQUEST_METHOD: $REQUEST_METHOD\r\n"
    printf "CONTENT_TYPE: $CONTENT_TYPE\r\n"
    printf "CONTENT_LENGTH: $CONTENT_LENGTH\r\n"
    printf "REMOTE_ADDR: $REMOTE_ADDR\r\n"
    printf "REQUEST_METHOD: \"$REQUEST_METHOD\"\r\n"
    printf "CONTENT_TYPE: \"$CONTENT_TYPE\"\r\n"
    printf "CONTENT_LENGTH: \"$CONTENT_LENGTH\"\r\n"

    printf "REMOTE_ADDR: \"$REMOTE_ADDR\"\r\n"
    printf "REMOTE_PORT: \"$REMOTE_PORT\"\r\n"
    printf "SERVER_PORT: \"$SERVER_PORT\"\r\n"

    printf "REQUEST_URI: \"$REQUEST_URI\"\r\n"
    printf "QUERY_STRING: \"$QUERY_STRING\"\r\n"

    # all headers from request now available with the HTTP_ prefix
    printf "HTTP_HOST: \"$HTTP_HOST\"\r\n"
    printf "HTTP_USER_AGENT: \"$HTTP_USER_AGENT\"\r\n"
    printf "HTTP_ACCEPT: \"$HTTP_ACCEPT\"\r\n"
    printf "HTTP_REFERER: \"$HTTP_REFERER\"\r\n"

    # username from basic auth (e.g. without password)
    printf "REMOTE_USER: \"$REMOTE_USER\"\r\n"

    printf "SCRIPT_NAME: \"$SCRIPT_NAME\"\r\n"
    printf "PATH_INFO: \"$PATH_INFO\"\r\n"
    printf "PATH: \"$PATH\"\r\n"
    printf "PWD: \"$PWD\"\r\n"

    printf "SERVER_PROTOCOL: \"$SERVER_PROTOCOL\"\r\n"
    printf "SERVER_SOFTWARE: \"$SERVER_SOFTWARE\"\r\n"

    printf "\r\n"
    printf "$CONTENT"
  10. @stokito stokito revised this gist Apr 6, 2023. 1 changed file with 11 additions and 0 deletions.
    11 changes: 11 additions & 0 deletions echo.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,11 @@
    #!/bin/sh
    # Echo CGI envs as headers and body
    CONTENT=$(cat -)
    printf "Content-Length: ${#CONTENT}\r\n"
    printf "Content-Type: text/html\r\n"
    printf "REQUEST_METHOD: $REQUEST_METHOD\r\n"
    printf "CONTENT_TYPE: $CONTENT_TYPE\r\n"
    printf "CONTENT_LENGTH: $CONTENT_LENGTH\r\n"
    printf "REMOTE_ADDR: $REMOTE_ADDR\r\n"
    printf "\r\n"
    printf "$CONTENT"
  11. @stokito stokito created this gist Apr 5, 2023.
    46 changes: 46 additions & 0 deletions README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,46 @@
    # CGI samples

    ## CGI Variables
    Standard set of Common Gateway Interface environment variable are described in RFC3875. For example:
    ```
    CONTENT_TYPE=application/x-www-form-urlencoded
    GATEWAY_INTERFACE=CGI/1.1
    REMOTE_ADDR=192.168.1.180
    QUERY_STRING=Zbr=1234567&SrceMB=&ime=jhkjhlkh+klhlkjhlk+%A9%D0%C6%AE%C6%AE&prezime=&sektor=OP
    REMOTE_PORT=2292
    CONTENT_LENGTH=128
    REQUEST_URI=/cgi-bin/printenvs
    SERVER_SOFTWARE=busybox httpd/1.35 6-Oct-2004
    PATH=/bin:/sbin:/usr/bin:/usr/sbin
    HTTP_REFERER=http://192.168.1.1/index1.html
    SERVER_PROTOCOL=HTTP/1.0
    PATH_INFO=
    REQUEST_METHOD=POST
    PWD=/www/cgi-bin
    SERVER_PORT=80
    SCRIPT_NAME=/cgi-bin/printenvs
    REMOTE_USER=[http basic auth username]
    ```

    Example of CGI script that prints them `/cgi-bin/printenvs.cgi`
    Environment variables are set up and the script is invoked with pipes for stdin/stdout.

    ## Other samples

    httpd expects it's CGI script files to be in the subdirectory cgi-bin under main web directory set by options `-h` (default is `/www`, so `/www/cgi-bin`).
    The CGI script files must also have permission to be executed (min mode 700) e.g `chmod +x /cgi-bin/index.cgi`.
    If directory URL is given, no index.html is found and CGI support is enabled, then `cgi-bin/index.cgi` will be executed.

    BusyBox sources contains two useful CGI programs:

    * [httpd_indexcgi.c](https://git.busybox.net/busybox/tree/networking/httpd_indexcgi.c) generates a directory listing i.e. list of files. Other Web Servers has this as built-in feature but for BB http this is delegated to a CGI program.
    * [httpd_ssi.c](https://git.busybox.net/busybox/tree/networking/httpd_ssi.c) processes [Server Side Includes SSI](https://en.wikipedia.org/wiki/Server%20Side%20Includes)
    Use httpd_helpers.sh to compile them.

    Also there is and example of shell script to process File Upload [httpd_post_upload.cgi](https://git.busybox.net/busybox/tree/networking/httpd_post_upload.cgi)

    * https://github.com/yurt-page/cgi-oauth plain shell
    * https://github.com/yurt-page/cgi-ubus plain shell
    * https://github.com/ruudud/cgi bash samples
    * https://git.zx2c4.com/cgit/tree/README cgit
    * https://github.com/OpenPrinting/cups/tree/master/cgi-bin CUPS printing
    59 changes: 59 additions & 0 deletions httpd_post_upload.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,59 @@
    #!/bin/sh
    # GPLv2. From BuxyBox https://git.busybox.net/busybox/tree/networking/httpd_post_upload.cgi
    # post_upload.htm example:
    # <html>
    # <body>
    # <form action=/cgi-bin/httpd_post_upload.cgi method=post enctype=multipart/form-data>
    # File to upload: <input type=file name=file1> <input type=submit>
    # </form>

    # POST upload format:
    # -----------------------------29995809218093749221856446032^M
    # Content-Disposition: form-data; name="file1"; filename="..."^M
    # Content-Type: application/octet-stream^M
    # ^M <--------- headers end with empty line
    # file contents
    # file contents
    # file contents
    # ^M <--------- extra empty line
    # -----------------------------29995809218093749221856446032--^M

    file=$(mktemp)

    CR=`printf '\r'`

    # CGI output must start with at least empty line (or headers)
    printf '\r\n'

    IFS="$CR"
    read -r delim_line
    IFS=""

    while read -r line; do
    test x"$line" = x"" && break
    test x"$line" = x"$CR" && break
    done

    cat >"$file"

    # We need to delete the tail of "\r\ndelim_line--\r\n"
    tail_len=$((${#delim_line} + 6))

    # Get and check file size
    filesize=`stat -c"%s" "$file"`
    test "$filesize" -lt "$tail_len" && exit 1

    # Check that tail is correct
    dd if="$file" skip=$((filesize - tail_len)) bs=1 count=1000 >"$file.tail" 2>/dev/null
    printf "\r\n%s--\r\n" "$delim_line" >"$file.tail.expected"
    if ! diff -q "$file.tail" "$file.tail.expected" >/dev/null; then
    printf "<html>\n<body>\nMalformed file upload"
    exit 1
    fi
    rm "$file.tail"
    rm "$file.tail.expected"

    # Truncate the file
    dd of="$file" seek=$((filesize - tail_len)) bs=1 count=0 >/dev/null 2>/dev/null

    printf "<html>\n<body>\nFile upload has been accepted"
    5 changes: 5 additions & 0 deletions printenvs.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,5 @@
    #!/bin/sh
    echo "Content-Type: text/html"
    echo ""
    echo "Environment variables:"
    env
    6 changes: 6 additions & 0 deletions redirect.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,6 @@
    #!/bin/sh
    cat <<EOF
    Status: 302 Redirect
    Location: http://$SERVER_NAME:$SERVER_PORT/
    EOF
    5 changes: 5 additions & 0 deletions slow.cgi
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,5 @@
    #!/bin/sh
    # GPLv2. From webfs sources
    echo "Content-Type: text/plain"
    echo
    set | while read line; do echo $line; sleep 1; done