Browse Source
nginx-util: add tests, clean up and fix issues
Add tests for nginx-ssl-util and nginx-ssl-util-nopcre using (fake)chroot. Clean the code up making nginx-ssl-util a header file. Both changes are for better (future) code quality only. There are minor functional improvements: * fix compiler error of gcc7 by using std=c++17 * fix error if there is no lan/loopback interface * notice instead of error message if there is no default server * add ipv6-prefix-assignment.*.local-address.address for LAN * add CONFLICTS in Makefile for choosing the right version * add cast to release of unique_ptr to avoid warning * add version message to help message Signed-off-by: Peter Stadler <peter.stadler@student.uibk.ac.at>lilik-openwrt-22.03
Peter Stadler
5 years ago
8 changed files with 408 additions and 64 deletions
Split View
Diff Options
-
+14 -4net/nginx-util/Makefile
-
+32 -11net/nginx-util/src/CMakeLists.txt
-
+5 -9net/nginx-util/src/nginx-ssl-util.hpp
-
+62 -35net/nginx-util/src/nginx-util.cpp
-
+251 -0net/nginx-util/src/test-nginx-util-root.sh
-
+38 -0net/nginx-util/src/test-nginx-util.sh
-
+5 -4net/nginx-util/src/test-px5g.sh
-
+1 -1net/nginx-util/src/ubus-cxx.hpp
+ 14
- 4
net/nginx-util/Makefile
View File
+ 32
- 11
net/nginx-util/src/CMakeLists.txt
View File
| @ -1,38 +1,59 @@ | |||
| cmake_minimum_required(VERSION 2.6) | |||
| PROJECT(nginx-util CXX) | |||
| SET(CMAKE_CXX_STANDARD 17) | |||
| INCLUDE(CheckFunctionExists) | |||
| IF(UBUS) | |||
| FIND_PATH(ubus_include_dir libubus.h) | |||
| FIND_LIBRARY(ubox NAMES ubox) | |||
| FIND_LIBRARY(ubus NAMES ubus) | |||
| INCLUDE_DIRECTORIES(${ubus_include_dir}) | |||
| ENDIF() | |||
| ADD_DEFINITIONS(-Os -Wall -Werror -Wextra --std=c++2a -g3) | |||
| ADD_DEFINITIONS(-Os -Wall -Werror -Wextra -g3) | |||
| ADD_DEFINITIONS(-Wno-unused-parameter -Wmissing-declarations) | |||
| SET(CMAKE_SHARED_LIBRARY_LINK_C_FLAGS "") | |||
| ADD_EXECUTABLE(px5g px5g.cpp) | |||
| TARGET_LINK_LIBRARIES(px5g ssl crypto) | |||
| IF(UBUS) | |||
| ADD_COMPILE_DEFINITIONS(VERSION=${VERSION}) | |||
| ADD_EXECUTABLE(nginx-util nginx-util.cpp) | |||
| TARGET_COMPILE_DEFINITIONS(nginx-util PUBLIC -DNO_SSL) | |||
| TARGET_LINK_LIBRARIES(nginx-util ${ubox} ${ubus} pthread) | |||
| INSTALL(TARGETS nginx-util RUNTIME DESTINATION bin) | |||
| ADD_EXECUTABLE(nginx-ssl-util nginx-ssl-util.cpp) | |||
| ADD_EXECUTABLE(nginx-ssl-util nginx-util.cpp) | |||
| TARGET_LINK_LIBRARIES(nginx-ssl-util ${ubox} ${ubus} pthread ssl crypto pcre) | |||
| INSTALL(TARGETS nginx-ssl-util RUNTIME DESTINATION bin) | |||
| ADD_EXECUTABLE(nginx-ssl-util-nopcre nginx-ssl-util.cpp) | |||
| ADD_EXECUTABLE(nginx-ssl-util-nopcre nginx-util.cpp) | |||
| TARGET_COMPILE_DEFINITIONS(nginx-ssl-util-nopcre PUBLIC -DNO_PCRE) | |||
| TARGET_LINK_LIBRARIES(nginx-ssl-util-nopcre ${ubox} ${ubus} pthread ssl crypto) | |||
| INSTALL(TARGETS nginx-ssl-util-nopcre RUNTIME DESTINATION bin) | |||
| ELSE() | |||
| CONFIGURE_FILE(test-px5g.sh test-px5g.sh COPYONLY) | |||
| CONFIGURE_FILE(test-nginx-util.sh test-nginx-util.sh COPYONLY) | |||
| CONFIGURE_FILE(test-nginx-util-root.sh test-nginx-util-root.sh COPYONLY) | |||
| ADD_EXECUTABLE(nginx-ssl-util-noubus nginx-ssl-util.cpp) | |||
| ADD_EXECUTABLE(px5g px5g.cpp) | |||
| TARGET_LINK_LIBRARIES(px5g ssl crypto) | |||
| INSTALL(TARGETS px5g RUNTIME DESTINATION bin) | |||
| ADD_EXECUTABLE(nginx-ssl-util-noubus nginx-util.cpp) | |||
| TARGET_COMPILE_DEFINITIONS(nginx-ssl-util-noubus PUBLIC -DNO_UBUS) | |||
| TARGET_LINK_LIBRARIES(nginx-ssl-util-noubus pthread ssl crypto pcre) | |||
| INSTALL(TARGETS nginx-ssl-util-noubus RUNTIME DESTINATION bin) | |||
| INSTALL(TARGETS px5g RUNTIME DESTINATION bin) | |||
| INSTALL(TARGETS nginx-util RUNTIME DESTINATION bin) | |||
| INSTALL(TARGETS nginx-ssl-util RUNTIME DESTINATION bin) | |||
| INSTALL(TARGETS nginx-ssl-util-nopcre RUNTIME DESTINATION bin) | |||
| # INSTALL(TARGETS nginx-ssl-util-noubus RUNTIME DESTINATION bin) | |||
| ADD_EXECUTABLE(nginx-ssl-util-nopcre-noubus nginx-util.cpp) | |||
| TARGET_COMPILE_DEFINITIONS(nginx-ssl-util-nopcre-noubus PUBLIC -DNO_PCRE -DNO_UBUS) | |||
| TARGET_LINK_LIBRARIES(nginx-ssl-util-nopcre-noubus pthread ssl crypto) | |||
| INSTALL(TARGETS nginx-ssl-util-nopcre-noubus RUNTIME DESTINATION bin) | |||
| ENDIF() | |||
net/nginx-util/src/nginx-ssl-util.cpp → net/nginx-util/src/nginx-ssl-util.hpp
View File
+ 62
- 35
net/nginx-util/src/nginx-util.cpp
View File
+ 251
- 0
net/nginx-util/src/test-nginx-util-root.sh
View File
| @ -0,0 +1,251 @@ | |||
| #!/bin/bash | |||
| PRINT_PASSED=2 | |||
| NGINX_UTIL="/usr/bin/nginx-util" | |||
| __esc_newlines() { | |||
| echo "${1}" | sed -E 's/$/\\n/' | tr -d '\n' | sed -E 's/\\n$/\n/' | |||
| } | |||
| __esc_sed_rhs() { | |||
| __esc_newlines "${1}" | sed -E 's/[&/\]/\\&/g' | |||
| } | |||
| _sed_rhs() { | |||
| __esc_sed_rhs "$(echo "${1}" | sed -E "s/[$]/$(__esc_sed_rhs "${2}")/g")" | |||
| } | |||
| __esc_regex() { | |||
| __esc_newlines "${1}" | sed -E 's/[^^_a-zA-Z0-9-]/[&]/g; s/\^/\\^/g' | |||
| } | |||
| _regex() { | |||
| __esc_regex "${1}" | sed -E -e 's/^(\[\s])*/^\\s*/' \ | |||
| -e 's/(\[\s])+\[[*]]/(\\s.*)?/g' \ | |||
| -e 's/(\[\s])+/\\s+/g' \ | |||
| -e 's/(\[\s])*\[[;]]/\\s*;/g' \ | |||
| -e "s/\[['\"]]/['\"]?/g" \ | |||
| -e "s/\[[$]]/$(__esc_sed_rhs "$(__esc_regex "${2}")")/g" | |||
| } | |||
| _echo_sed() { | |||
| echo "" | sed -E "c${1}" | |||
| } | |||
| setpoint_add_ssl() { | |||
| local indent="\n$1" | |||
| local name="$2" | |||
| local default="" | |||
| [ "${name}" == "${LAN_NAME}" ] && default=".default" | |||
| local prefix="${CONF_DIR}${name}" | |||
| local CONF="$(grep -vE "$(_regex "${NGX_INCLUDE}" \ | |||
| "${LAN_LISTEN}${default}")" "${prefix}.sans" 2>/dev/null)" | |||
| local ADDS="" | |||
| echo "${CONF}" \ | |||
| | grep -qE "$(_regex "${NGX_INCLUDE}" "${LAN_SSL_LISTEN}${default}")" \ | |||
| || ADDS="${ADDS}${indent}$(_sed_rhs "${NGX_INCLUDE}" \ | |||
| "${LAN_SSL_LISTEN}${default}")" | |||
| echo "${CONF}" | grep -qE "$(_regex "${NGX_SSL_CRT}" "${prefix}")" \ | |||
| || ADDS="${ADDS}${indent}$(_sed_rhs "${NGX_SSL_CRT}" "${prefix}")" | |||
| echo "${CONF}" | grep -qE "$(_regex "${NGX_SSL_KEY}" "${prefix}")" \ | |||
| || ADDS="${ADDS}${indent}$(_sed_rhs "${NGX_SSL_KEY}" "${prefix}")" | |||
| echo "${CONF}" | grep -qE "^\s*ssl_session_cache\s" \ | |||
| || ADDS="${ADDS}${indent}$(_sed_rhs "${NGX_SSL_SESSION_CACHE}" "${name}")" | |||
| echo "${CONF}" | grep -qE "^\s*ssl_session_timeout\s" \ | |||
| || ADDS="${ADDS}${indent}$(_sed_rhs "${NGX_SSL_SESSION_TIMEOUT}" "")" | |||
| if [ -n "${ADDS}" ] | |||
| then | |||
| ADDS="$(echo "${ADDS}" | sed -E 's/^\\n//')" | |||
| echo "${CONF}" | grep -qE "$(_regex "${NGX_SERVER_NAME}" "${name}")" \ | |||
| && echo "${CONF}" \ | |||
| | sed -E "/$(_regex "${NGX_SERVER_NAME}" "${name}")/a\\${ADDS}" \ | |||
| > "${prefix}.with" \ | |||
| && _echo_sed "Added directives to ${prefix}.with:\n${ADDS}" \ | |||
| && return 0 \ | |||
| || _echo_sed "Cannot add directives to ${prefix}.sans, missing:\ | |||
| \n$(_sed_rhs "${NGX_SERVER_NAME}" "${name}")\n${ADDS}" | |||
| return 1 | |||
| fi | |||
| return 0 | |||
| } | |||
| # ---------------------------------------------------------------------------- | |||
| function test() { | |||
| eval "$1 2>/dev/null >/dev/null " | |||
| if [ $? -eq $2 ] | |||
| then | |||
| [ "${PRINT_PASSED}" -gt 0 ] \ | |||
| && printf "%-72s%-1s\n" "$1" "2>/dev/null >/dev/null (-> $2?) passed." | |||
| else | |||
| printf "%-72s%-1s\n" "$1" "2>/dev/null >/dev/null (-> $2?) failed!!!" | |||
| [ "${PRINT_PASSED}" -gt 1 ] && exit 1 | |||
| fi | |||
| } | |||
| [ "$PRINT_PASSED" -gt 0 ] && printf "\nTesting ${NGINX_UTIL} get_env ...\n" | |||
| eval $("${NGINX_UTIL}" get_env) | |||
| test '[ -n "${NGINX_CONF}" ]' 0 | |||
| test '[ -n "${CONF_DIR}" ]' 0 | |||
| test '[ -n "${LAN_NAME}" ]' 0 | |||
| test '[ -n "${LAN_LISTEN}" ]' 0 | |||
| test '[ -n "${LAN_SSL_LISTEN}" ]' 0 | |||
| test '[ -n "${SSL_SESSION_CACHE_ARG}" ]' 0 | |||
| test '[ -n "${SSL_SESSION_TIMEOUT_ARG}" ]' 0 | |||
| test '[ -n "${ADD_SSL_FCT}" ]' 0 | |||
| [ "$PRINT_PASSED" -gt 0 ] && printf "\nPrepare files in ${CONF_DIR} ...\n" | |||
| mkdir -p ${CONF_DIR} | |||
| cd ${CONF_DIR} | |||
| NGX_INCLUDE="include '\$';" | |||
| NGX_SERVER_NAME="server_name * '\$' *;" | |||
| NGX_SSL_CRT="ssl_certificate '\$.crt';" | |||
| NGX_SSL_KEY="ssl_certificate_key '\$.key';" | |||
| NGX_SSL_SESSION_CACHE="ssl_session_cache '$(echo "${SSL_SESSION_CACHE_ARG}" \ | |||
| | sed -E "s/$(__esc_regex ${LAN_NAME})/\$/")';" | |||
| NGX_SSL_SESSION_TIMEOUT="ssl_session_timeout '${SSL_SESSION_TIMEOUT_ARG}';" | |||
| cat > ${LAN_NAME}.sans <<EOF | |||
| # default_server for the LAN addresses getting the IPs by: | |||
| # ifstatus lan | jsonfilter -e '@["ipv4-address","ipv6-address"].*.address' | |||
| server { | |||
| include '${LAN_LISTEN}.default'; | |||
| server_name ${LAN_NAME}; | |||
| include conf.d/*.locations; | |||
| } | |||
| EOF | |||
| CONFS="${CONFS} ${LAN_NAME}:0" | |||
| cat > minimal.sans <<EOF | |||
| server { | |||
| server_name minimal; | |||
| } | |||
| EOF | |||
| CONFS="${CONFS} minimal:0" | |||
| cat > normal.sans <<EOF | |||
| server { | |||
| include '${LAN_LISTEN}'; | |||
| server_name normal; | |||
| } | |||
| EOF | |||
| CONFS="${CONFS} normal:0" | |||
| cat > more_server.sans <<EOF | |||
| server { | |||
| # include '${LAN_LISTEN}'; | |||
| server_name normal; | |||
| } | |||
| server { | |||
| include '${LAN_LISTEN}'; | |||
| server_name more_server; | |||
| } | |||
| EOF | |||
| CONFS="${CONFS} more_server:0" | |||
| cat > more_names.sans <<EOF | |||
| server { | |||
| include '${LAN_LISTEN}'; | |||
| server_name example.com more_names example.org; | |||
| } | |||
| EOF | |||
| CONFS="${CONFS} more_names:0" | |||
| cat > different_name.sans <<EOF | |||
| server { | |||
| include '${LAN_LISTEN}'; | |||
| server_name minimal; | |||
| } | |||
| EOF | |||
| CONFS="${CONFS} different_name:1" | |||
| cat > comments.sans <<EOF | |||
| server { # comment1 | |||
| # comment2 | |||
| include '${LAN_LISTEN}'; | |||
| server_name comments; | |||
| # comment3 | |||
| } # comment4 | |||
| EOF | |||
| CONFS="${CONFS} comments:0" | |||
| cat > name_comment.sans <<EOF | |||
| server { | |||
| include '${LAN_LISTEN}'; | |||
| server_name name_comment; # comment | |||
| } | |||
| EOF | |||
| CONFS="${CONFS} name_comment:0" | |||
| cat > tab.sans <<EOF | |||
| server { | |||
| include '${LAN_LISTEN}'; | |||
| server_name tab; | |||
| } | |||
| EOF | |||
| CONFS="${CONFS} tab:0" | |||
| [ "$PRINT_PASSED" -gt 0 ] && printf "\nTesting ${NGINX_UTIL} init_lan ...\n" | |||
| mkdir -p "$(dirname "${LAN_LISTEN}")" | |||
| cp ${LAN_NAME}.sans ${LAN_NAME}.conf | |||
| test '${NGINX_UTIL} init_lan' 0 | |||
| [ "$PRINT_PASSED" -gt 0 ] && printf "\nSetup files in ${CONF_DIR} ...\n" | |||
| for conf in ${CONFS} | |||
| do test 'setpoint_add_ssl " " '${conf%:*} ${conf#*:} | |||
| done | |||
| test 'setpoint_add_ssl "\t" tab' 0 # fixes wrong indentation. | |||
| [ "$PRINT_PASSED" -gt 0 ] && printf "\nTesting ${NGINX_UTIL} add_ssl ...\n" | |||
| cp different_name.sans different_name.with | |||
| test '[ "${ADD_SSL_FCT}" == "add_ssl" ] ' 0 | |||
| for conf in ${CONFS}; do | |||
| name=${conf%:*} | |||
| cp ${name}.sans ${name}.conf | |||
| test '${NGINX_UTIL} add_ssl '${name} ${conf#*:} | |||
| (test '[ "$(cat '${name}'.conf)" == "$(cat '${name}'.with)" ]' 0 >/dev/null) | |||
| [ "$?" -gt 0 ] && { | |||
| echo "created ${name}.conf:"; cat "${name}.conf" | |||
| echo "differs from setpoint:"; cat "${name}.with" | |||
| exit 1 | |||
| } | |||
| done | |||
| [ "$PRINT_PASSED" -gt 0 ] && printf "\nTesting ${NGINX_UTIL} del_ssl ...\n" | |||
| sed -i "/server {/a\\ include '${LAN_LISTEN}';" minimal.sans | |||
| for conf in ${CONFS}; do | |||
| name=${conf%:*} | |||
| cp ${name}.with ${name}.conf | |||
| test '${NGINX_UTIL} del_ssl '${name} ${conf#*:} | |||
| (test '[ "$(cat '${name}'.conf)" == "$(cat '${name}'.sans)" ]' 0 >/dev/null) | |||
| [ "$?" -gt 0 ] && { | |||
| echo "created ${name}.conf:"; cat "${name}.conf" | |||
| echo "differs from setpoint:"; cat "${name}.sans" | |||
| exit 1 | |||
| } | |||
| done | |||
+ 38
- 0
net/nginx-util/src/test-nginx-util.sh
View File
| @ -0,0 +1,38 @@ | |||
| #!/bin/bash | |||
| printf "Initializing tests ...\n" | |||
| fakechroot="" | |||
| [ -x /usr/bin/fakechroot ] && fakechroot="/usr/bin/fakechroot" \ | |||
| || [ "$(id -u)" -eq 0 ] || { \ | |||
| printf "Error: Testing needs fakechroot or whoami=root for chroot." | |||
| return 1 | |||
| } | |||
| TMPROOT=$(mktemp -d /tmp/test-nginx-util-XXXXXX) | |||
| ln -s /bin ${TMPROOT}/bin | |||
| mkdir -p ${TMPROOT}/usr/bin/ | |||
| cp ./test-nginx-util-root.sh ${TMPROOT}/usr/bin/ | |||
| printf "\n\n******* Testing nginx-ssl-util-noubus *******\n" | |||
| cp ./nginx-ssl-util-noubus ${TMPROOT}/usr/bin/nginx-util | |||
| ${fakechroot} /bin/chroot ${TMPROOT} /bin/sh -c /usr/bin/test-nginx-util-root.sh | |||
| echo $? | |||
| printf "\n\n******* Testing nginx-ssl-util-nopcre-noubus *******\n" | |||
| cp ./nginx-ssl-util-nopcre-noubus ${TMPROOT}/usr/bin/nginx-util | |||
| ${fakechroot} /bin/chroot ${TMPROOT} /bin/sh -c /usr/bin/test-nginx-util-root.sh | |||
| rm -r ${TMPROOT} | |||