From 6e7bd3d84c58da8371dda75b339c37294ef45bc6 Mon Sep 17 00:00:00 2001 From: Marcin Krol Date: Sat, 28 Oct 2017 12:41:55 +0000 Subject: [PATCH] - doh, these are custom ones, do not duplicate function names --- hook.custom_functions | 117 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 117 insertions(+) create mode 100644 hook.custom_functions diff --git a/hook.custom_functions b/hook.custom_functions new file mode 100644 index 0000000..03a27cf --- /dev/null +++ b/hook.custom_functions @@ -0,0 +1,117 @@ +#!/bin/bash + +# This file contains global custom functions for your dehydrated hook scripts. +# Feel free to edit it, but do not delete predefined custom functions for +# handling dehydrated actions. They are referenced in hooks.sh. + +custom_deploy_challenge() { + # This hook is called once for every domain that needs to be + # validated, including any alternative names you may have listed. + # + # Parameters: + # - DOMAIN + # The domain name (CN or subject alternative name) being + # validated. + # - TOKEN_FILENAME + # The name of the file containing the token to be served for HTTP + # validation. Should be served by your web server as + # /.well-known/acme-challenge/${TOKEN_FILENAME}. + # - TOKEN_VALUE + # The token value that needs to be served for validation. For DNS + # validation, this is what you want to put in the _acme-challenge + # TXT record. For HTTP validation it is the value that is expected + # be found in the $TOKEN_FILENAME file. + local DOMAIN="${1}" TOKEN_FILENAME="${2}" TOKEN_VALUE="${3}" +} + +custom_clean_challenge() { + # This hook is called after attempting to validate each domain, + # whether or not validation was successful. Here you can delete + # files or DNS records that are no longer needed. + # + # The parameters are the same as for deploy_challenge. + local DOMAIN="${1}" TOKEN_FILENAME="${2}" TOKEN_VALUE="${3}" +} + +custom_deploy_cert() { + local DOMAIN="${1}" KEYFILE="${2}" CERTFILE="${3}" FULLCHAINFILE="${4}" CHAINFILE="${5}" TIMESTAMP="${6}" + # This hook is called once for each certificate that has been + # produced. Here you might, for instance, copy your new certificates + # to service-specific locations and reload the service. + # + # Parameters: + # - DOMAIN + # The primary domain name, i.e. the certificate common + # name (CN). + # - KEYFILE + # The path of the file containing the private key. + # - CERTFILE + # The path of the file containing the signed certificate. + # - FULLCHAINFILE + # The path of the file containing the full certificate chain. + # - CHAINFILE + # The path of the file containing the intermediate certificate(s). + # - TIMESTAMP + # Timestamp when the specified certificate was created. + local DOMAIN="${1}" KEYFILE="${2}" CERTFILE="${3}" FULLCHAINFILE="${4}" CHAINFILE="${5}" TIMESTAMP="${6}" +} + +custom_unchanged_cert() { + # This hook is called once for each certificate that is still + # valid and therefore wasn't reissued. + # + # Parameters: + # - DOMAIN + # The primary domain name, i.e. the certificate common + # name (CN). + # - KEYFILE + # The path of the file containing the private key. + # - CERTFILE + # The path of the file containing the signed certificate. + # - FULLCHAINFILE + # The path of the file containing the full certificate chain. + # - CHAINFILE + # The path of the file containing the intermediate certificate(s). + local DOMAIN="${1}" KEYFILE="${2}" CERTFILE="${3}" FULLCHAINFILE="${4}" CHAINFILE="${5}" +} + +custom_invalid_challenge() { + # This hook is called if the challenge response has failed, so domain + # owners can be aware and act accordingly. + # + # Parameters: + # - DOMAIN + # The primary domain name, i.e. the certificate common + # name (CN). + # - RESPONSE + # The response that the verification server returned + local DOMAIN="${1}" RESPONSE="${2}" +} + +custom_request_failure() { + # This hook is called when an HTTP request fails (e.g., when the ACME + # server is busy, returns an error, etc). It will be called upon any + # response code that does not start with '2'. Useful to alert admins + # about problems with requests. + # + # Parameters: + # - STATUSCODE + # The HTML status code that originated the error. + # - REASON + # The specified reason for the error. + # - REQTYPE + # The kind of request that was made (GET, POST...) + local STATUSCODE="${1}" REASON="${2}" REQTYPE="${3}" +} + +custom_startup_hook() { + # This hook is called before the cron command to do some initial tasks + # (e.g. starting a webserver). + : +} + +custom_exit_hook() { + # This hook is called at the end of the cron command and can be used to + # do some final (cleanup or other) tasks. + : +} -- 2.46.0