diff --git a/README.md b/README.md index 2cb8d59..ba22c6e 100644 --- a/README.md +++ b/README.md @@ -65,9 +65,41 @@ Enable reverse proxying. - `--with-stathost=HOST`: Set the default name of the stats host. +- `--enable-snap`: +Enable snap packaging and running tinyproxy in snap world. + For more information about the build system, read the INSTALL file that is generated by `autogen.sh` and comes with the release tar ball. +## Snap + +If you would like to build tinyproxy as a snap package, please make sure +you have snapd and snapcraft packages installed firstly. + +``` +sudo apt-get install snapd snapcraft +sudo snap install core +``` + +Then run the following command to create a snap package. + +``` +cd snap && snapcraft +``` + +After it's done, you can simply run the following command to install it +locally. + +``` +sudo snap install --dangerous tinyproxy-snap_[VER]_[ARCH].snap +``` + +Also you can install tinyproxy from the store by running the following +command. + +``` +sudo snap install tinyproxy +``` ## Support diff --git a/configure.ac b/configure.ac index 3990c2f..4248160 100644 --- a/configure.ac +++ b/configure.ac @@ -131,6 +131,16 @@ if test x"$transparent_enabled" = x"yes"; then AC_DEFINE(TRANSPARENT_PROXY) fi +dnl Include support for packaging and running tinyproxy in snap world. +AH_TEMPLATE([SNAP_SUPPORT], + [Include support for snap package.]) +TP_ARG_ENABLE(snap, + [Enable snap packaging (default is NO)], + no) +if test x"$snap_enabled" = x"yes"; then + AC_DEFINE(SNAP_SUPPORT) +fi + # This is required to build test programs below AC_PROG_CC diff --git a/snap/setup/gui/icon.png b/snap/setup/gui/icon.png new file mode 100755 index 0000000..ce87640 Binary files /dev/null and b/snap/setup/gui/icon.png differ diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml new file mode 100644 index 0000000..fba9b57 --- /dev/null +++ b/snap/snapcraft.yaml @@ -0,0 +1,50 @@ +name: tinyproxy-snap +version: '0.2' +summary: a light-weight HTTP(S) proxy daemon for POSIX operating systems. +description: | + Tinyproxy is a small, efficient HTTP/SSL proxy daemon released under the GNU General Public License. + Tinyproxy is very useful in a small network setting, where a larger proxy would either be too resource intensive, or a security risk. + + usage: $ sudo snap set tinyproxy port=9876 + $ sudo snap disable tinyproxy + $ sudo snap enable tinyproxy + supported parameters: + - port: The socket addresses where tinyproxy will listen for HTTP/HTTPS client requests. The default value is '8888' + - max-clients: This is the absolute highest number of threads which will be created. The default value is 100. + - start-servers: The number of servers to start initially. The default value is 10. + +grade: stable +confinement: strict + +apps: + tinyproxy: + command: run-tinyproxy start + daemon: simple + plugs: [ network, network-bind ] + +parts: + tinyproxy: + plugin: autotools + source: https://github.com/tinyproxy/tinyproxy.git + source-type: git + source-tag: 1.8.4 + configflags: + - --enable-xtinyproxy + - --enable-filter + - --enable-upstream + - --enable-reverse + - --enable-transparent + - --enable-snap + build-packages: + - asciidoc + - xsltproc + organize: + sbin: bin + stage: + - -etc + tinyproxy-customized: + plugin: dump + organize: + src/tinyproxy/script/*: bin/ + src/tinyproxy/conf/tinyproxy.conf.template: etc/ + src/tinyproxy/conf/configure: meta/hooks/configure diff --git a/snap/src/tinyproxy/conf/tinyproxy.conf.template b/snap/src/tinyproxy/conf/tinyproxy.conf.template new file mode 100644 index 0000000..c07811d --- /dev/null +++ b/snap/src/tinyproxy/conf/tinyproxy.conf.template @@ -0,0 +1,330 @@ +## +## tinyproxy.conf -- tinyproxy daemon configuration file +## +## This example tinyproxy.conf file contains example settings +## with explanations in comments. For decriptions of all +## parameters, see the tinproxy.conf(5) manual page. +## + +# +# User/Group: This allows you to set the user and group that will be +# used for tinyproxy after the initial binding to the port has been done +# as the root user. Either the user or group name or the UID or GID +# number may be used. +# +User root +Group root + +# +# Port: Specify the port which tinyproxy will listen on. Please note +# that should you choose to run on a port lower than 1024 you will need +# to start tinyproxy using root. +# +Port 8888 + +# +# Listen: If you have multiple interfaces this allows you to bind to +# only one. If this is commented out, tinyproxy will bind to all +# interfaces present. +# +#Listen 192.168.0.1 + +# +# Bind: This allows you to specify which interface will be used for +# outgoing connections. This is useful for multi-home'd machines where +# you want all traffic to appear outgoing from one particular interface. +# +#Bind 192.168.0.1 + +# +# BindSame: If enabled, tinyproxy will bind the outgoing connection to the +# ip address of the incoming connection. +# +#BindSame yes + +# +# Timeout: The maximum number of seconds of inactivity a connection is +# allowed to have before it is closed by tinyproxy. +# +Timeout 600 + +# +# ErrorFile: Defines the HTML file to send when a given HTTP error +# occurs. You will probably need to customize the location to your +# particular install. The usual locations to check are: +# /usr/local/share/tinyproxy +# /usr/share/tinyproxy +# /etc/tinyproxy +# +#ErrorFile 404 "@pkgdatadir@/404.html" +#ErrorFile 400 "@pkgdatadir@/400.html" +#ErrorFile 503 "@pkgdatadir@/503.html" +#ErrorFile 403 "@pkgdatadir@/403.html" +#ErrorFile 408 "@pkgdatadir@/408.html" + +# +# DefaultErrorFile: The HTML file that gets sent if there is no +# HTML file defined with an ErrorFile keyword for the HTTP error +# that has occured. +# +DefaultErrorFile "${SNAP}/share/tinyproxy/default.html" + +# +# StatHost: This configures the host name or IP address that is treated +# as the stat host: Whenever a request for this host is received, +# Tinyproxy will return an internal statistics page instead of +# forwarding the request to that host. The default value of StatHost is +# @TINYPROXY_STATHOST@. +# +#StatHost "@TINYPROXY_STATHOST@" +# + +# +# StatFile: The HTML file that gets sent when a request is made +# for the stathost. If this file doesn't exist a basic page is +# hardcoded in tinyproxy. +# +StatFile "${SNAP}/share/tinyproxy/stats.html" + +# +# LogFile: Allows you to specify the location where information should +# be logged to. If you would prefer to log to syslog, then disable this +# and enable the Syslog directive. These directives are mutually +# exclusive. +# +LogFile "${SNAP_DATA}/var/log/tinyproxy/tinyproxy.log" + +# +# Syslog: Tell tinyproxy to use syslog instead of a logfile. This +# option must not be enabled if the Logfile directive is being used. +# These two directives are mutually exclusive. +# +#Syslog On + +# +# LogLevel: +# +# Set the logging level. Allowed settings are: +# Critical (least verbose) +# Error +# Warning +# Notice +# Connect (to log connections without Info's noise) +# Info (most verbose) +# +# The LogLevel logs from the set level and above. For example, if the +# LogLevel was set to Warning, then all log messages from Warning to +# Critical would be output, but Notice and below would be suppressed. +# +LogLevel Info + +# +# PidFile: Write the PID of the main tinyproxy thread to this file so it +# can be used for signalling purposes. +# +PidFile "${SNAP_DATA}/var/run/tinyproxy/tinyproxy.pid" + +# +# XTinyproxy: Tell Tinyproxy to include the X-Tinyproxy header, which +# contains the client's IP address. +# +#XTinyproxy Yes + +# +# Upstream: +# +# Turns on upstream proxy support. +# +# The upstream rules allow you to selectively route upstream connections +# based on the host/domain of the site being accessed. +# +# For example: +# # connection to test domain goes through testproxy +# upstream testproxy:8008 ".test.domain.invalid" +# upstream testproxy:8008 ".our_testbed.example.com" +# upstream testproxy:8008 "192.168.128.0/255.255.254.0" +# +# # no upstream proxy for internal websites and unqualified hosts +# no upstream ".internal.example.com" +# no upstream "www.example.com" +# no upstream "10.0.0.0/8" +# no upstream "192.168.0.0/255.255.254.0" +# no upstream "." +# +# # connection to these boxes go through their DMZ firewalls +# upstream cust1_firewall:8008 "testbed_for_cust1" +# upstream cust2_firewall:8008 "testbed_for_cust2" +# +# # default upstream is internet firewall +# upstream firewall.internal.example.com:80 +# +# The LAST matching rule wins the route decision. As you can see, you +# can use a host, or a domain: +# name matches host exactly +# .name matches any host in domain "name" +# . matches any host with no domain (in 'empty' domain) +# IP/bits matches network/mask +# IP/mask matches network/mask +# +#Upstream some.remote.proxy:port + +# +# MaxClients: This is the absolute highest number of threads which will +# be created. In other words, only MaxClients number of clients can be +# connected at the same time. +# +MaxClients 100 + +# +# MinSpareServers/MaxSpareServers: These settings set the upper and +# lower limit for the number of spare servers which should be available. +# +# If the number of spare servers falls below MinSpareServers then new +# server processes will be spawned. If the number of servers exceeds +# MaxSpareServers then the extras will be killed off. +# +MinSpareServers 5 +MaxSpareServers 20 + +# +# StartServers: The number of servers to start initially. +# +StartServers 10 + +# +# MaxRequestsPerChild: The number of connections a thread will handle +# before it is killed. In practise this should be set to 0, which +# disables thread reaping. If you do notice problems with memory +# leakage, then set this to something like 10000. +# +MaxRequestsPerChild 0 + +# +# Allow: Customization of authorization controls. If there are any +# access control keywords then the default action is to DENY. Otherwise, +# the default action is ALLOW. +# +# The order of the controls are important. All incoming connections are +# tested against the controls based on order. +# +#Allow 127.0.0.1 + +# +# AddHeader: Adds the specified headers to outgoing HTTP requests that +# Tinyproxy makes. Note that this option will not work for HTTPS +# traffic, as Tinyproxy has no control over what headers are exchanged. +# +#AddHeader "X-My-Header" "Powered by Tinyproxy" + +# +# ViaProxyName: The "Via" header is required by the HTTP RFC, but using +# the real host name is a security concern. If the following directive +# is enabled, the string supplied will be used as the host name in the +# Via header; otherwise, the server's host name will be used. +# +ViaProxyName "tinyproxy" + +# +# DisableViaHeader: When this is set to yes, Tinyproxy does NOT add +# the Via header to the requests. This virtually puts Tinyproxy into +# stealth mode. Note that RFC 2616 requires proxies to set the Via +# header, so by enabling this option, you break compliance. +# Don't disable the Via header unless you know what you are doing... +# +#DisableViaHeader Yes + +# +# Filter: This allows you to specify the location of the filter file. +# +#Filter "@sysconfdir@/filter" + +# +# FilterURLs: Filter based on URLs rather than domains. +# +#FilterURLs On + +# +# FilterExtended: Use POSIX Extended regular expressions rather than +# basic. +# +#FilterExtended On + +# +# FilterCaseSensitive: Use case sensitive regular expressions. +# +#FilterCaseSensitive On + +# +# FilterDefaultDeny: Change the default policy of the filtering system. +# If this directive is commented out, or is set to "No" then the default +# policy is to allow everything which is not specifically denied by the +# filter file. +# +# However, by setting this directive to "Yes" the default policy becomes +# to deny everything which is _not_ specifically allowed by the filter +# file. +# +#FilterDefaultDeny Yes + +# +# Anonymous: If an Anonymous keyword is present, then anonymous proxying +# is enabled. The headers listed are allowed through, while all others +# are denied. If no Anonymous keyword is present, then all headers are +# allowed through. You must include quotes around the headers. +# +# Most sites require cookies to be enabled for them to work correctly, so +# you will need to allow Cookies through if you access those sites. +# +#Anonymous "Host" +#Anonymous "Authorization" +#Anonymous "Cookie" + +# +# ConnectPort: This is a list of ports allowed by tinyproxy when the +# CONNECT method is used. To disable the CONNECT method altogether, set +# the value to 0. If no ConnectPort line is found, all ports are +# allowed (which is not very secure.) +# +# The following two ports are used by SSL. +# +ConnectPort 443 +ConnectPort 563 + +# +# Configure one or more ReversePath directives to enable reverse proxy +# support. With reverse proxying it's possible to make a number of +# sites appear as if they were part of a single site. +# +# If you uncomment the following two directives and run tinyproxy +# on your own computer at port 8888, you can access Google using +# http://localhost:8888/google/ and Wired News using +# http://localhost:8888/wired/news/. Neither will actually work +# until you uncomment ReverseMagic as they use absolute linking. +# +#ReversePath "/google/" "http://www.google.com/" +#ReversePath "/wired/" "http://www.wired.com/" + +# +# When using tinyproxy as a reverse proxy, it is STRONGLY recommended +# that the normal proxy is turned off by uncommenting the next directive. +# +#ReverseOnly Yes + +# +# Use a cookie to track reverse proxy mappings. If you need to reverse +# proxy sites which have absolute links you must uncomment this. +# +#ReverseMagic Yes + +# +# The URL that's used to access this reverse proxy. The URL is used to +# rewrite HTTP redirects so that they won't escape the proxy. If you +# have a chain of reverse proxies, you'll need to put the outermost +# URL here (the address which the end user types into his/her browser). +# +# If not set then no rewriting occurs. +# +#ReverseBaseURL "http://localhost:8888/" + + + diff --git a/snap/src/tinyproxy/script/run-tinyproxy b/snap/src/tinyproxy/script/run-tinyproxy new file mode 100755 index 0000000..e4a5f2e --- /dev/null +++ b/snap/src/tinyproxy/script/run-tinyproxy @@ -0,0 +1,17 @@ +#!/bin/bash + +test -d ${SNAP_DATA}/etc || mkdir -p ${SNAP_DATA}/etc +test -d ${SNAP_DATA}/var/run/tinyproxy || mkdir -p ${SNAP_DATA}/var/run/tinyproxy +test -d ${SNAP_DATA}/var/log/tinyproxy || mkdir -p ${SNAP_DATA}/var/log/tinyproxy +test -f ${SNAP_DATA}/etc/tinyproxy.conf || sed -e "s|\${SNAP_DATA}|$SNAP_DATA|" ${SNAP}/etc/tinyproxy.conf.template > ${SNAP_DATA}/etc/tinyproxy.conf.ori && sed -e "s|\${SNAP}|$SNAP|" ${SNAP_DATA}/etc/tinyproxy.conf.ori > ${SNAP_DATA}/etc/tinyproxy.conf + +#waiting custom_config file is generated. +#That's sth hooks feature neeeds. +while [ ! -f "$SNAP_DATA/custom_config" ]; do + sleep 1 + echo "waiting for custom config file generated." +done + +source ${SNAP}/bin/settings + +tinyproxy -d -c ${SNAP_DATA}/etc/tinyproxy.conf diff --git a/snap/src/tinyproxy/script/settings b/snap/src/tinyproxy/script/settings new file mode 100755 index 0000000..9f0b93b --- /dev/null +++ b/snap/src/tinyproxy/script/settings @@ -0,0 +1,24 @@ +#!/bin/bash + +source $SNAP_DATA/custom_config + +tinyproxy_conf="${SNAP_DATA}/etc/tinyproxy.conf" + +params=("Port" "MaxClients" "StartServers") +line_number=(23 176 192) +length=${#params[@]} + +#sed -i in-place option is not available by default on some other distro. +modify() { + sed -u "$1" "$2" > "$2".bak && mv "$2".bak "$2" +} + +for ((i = 0; i < $length; i++)) +do + if [ ! -z "${!params[i]}" ]; then + echo "customized config: ${params[i]}=${!params[i]}" + modify "${line_number[i]}d" $tinyproxy_conf + #space sensitive + modify "${line_number[i]}i${params[i]} ${!params[i]}" $tinyproxy_conf + fi +done diff --git a/src/main.c b/src/main.c index ae2a3a8..7f81f3e 100644 --- a/src/main.c +++ b/src/main.c @@ -436,12 +436,14 @@ main (int argc, char **argv) exit (EX_OSERR); } +#ifndef SNAP_SUPPORT /* Switch to a different user if we're running as root */ if (geteuid () == 0) change_user (argv[0]); else log_message (LOG_WARNING, "Not running as root, so not changing UID/GID."); +#endif /* Create log file after we drop privileges */ if (setup_logging ()) {