X-Git-Url: https://zdv2.bktei.com/gitweb/EVA-2020-02.git/blobdiff_plain/79bb6c16db0def5cb43b07e9a923b883eeb0737c..99f6bd4e6c6a6e51ffb667c51c91275ce927965c:/exec/bklog?ds=inline diff --git a/exec/bklog b/exec/bklog index f3722df..49ec813 100644 --- a/exec/bklog +++ b/exec/bklog @@ -11,7 +11,7 @@ dirTmpDefault="/dev/shm"; # Default parent of working directory # Script Metadata scriptName="bklog"; # Define basename of script file. -scriptVersion="0.1.5"; # Define version of script. +scriptVersion="0.1.10"; # Define version of script. scriptURL="https://gitlab.com/baltakatei/ninfacyzga-01"; # Define wesite hosting this script. scriptTimeStart="$(date +%Y%m%dT%H%M%S.%N)"; # YYYYmmddTHHMMSS.NNNNNNNNN scriptHostname=$(hostname); # Save hostname of system running this script. @@ -284,6 +284,46 @@ checkAgePubkey() { return 1; fi; } # Check age pubkey +checkMakeTar() { + # Desc: Checks that a valid tar archive exists, creates one otherwise + # Usage: checkMakeTar [ path ] + # Version: 1.0.2 + # Input: arg1: path of tar archive + # Output: exit code 0 : tar readable + # exit code 1 : tar missing; created + # exit code 2 : tar not readable; moved; replaced + # Depends: bash 5, date 8, tar 1, try() + local pathTar returnFlag0 returnFlag1 returnFlag2 + pathTar="$1"; + + # Check if file is a valid tar archive + if tar --list --file="$pathTar" 1>/dev/null 2>&1; then + ## T1: return success + returnFlag0="tar valid"; + else + ## F1: Check if file exists + if [[ -f "$pathTar" ]]; then + ### T: Rename file + try mv "$pathTar" "$pathTar""--broken--""$(date +%Y%m%dT%H%M%S)" && \ + returnFlag1="tar moved"; + else + ### F: - + : + fi; + ## F2: Create tar archive, return 0 + try tar --create --file="$pathTar" --files-from=/dev/null && \ + returnFlag2="tar created"; + fi; + + # Determine function return code + if [[ "$returnFlag0" = "tar valid" ]]; then + return 0; + elif [[ "$returnFlag2" = "tar created" ]] && ! [[ "$returnFlag1" = "tar moved" ]]; then + return 1; # tar missing so created + elif [[ "$returnFlag2" = "tar created" ]] && [[ "$returnFlag1" = "tar moved" ]]; then + return 2; # tar not readable so moved; replaced + fi; +} # checks if arg1 is tar; creates one otherwise dateShort(){ # Desc: Date without separators (YYYYmmdd) # Usage: dateShort ([str date]) @@ -624,6 +664,127 @@ timeDuration(){ fi } # Get duration (ex: PT10M4S ) +timeUntilNextDay(){ + # Desc: Report seconds until next day. + # Version: 1.0.2 + # Output: stdout: integer seconds until next day + # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0 + # Usage: timeUntilNextDay + # Usage: if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement"; exit 1; fi + # Depends: date 8, echo 8, yell, try + + local returnState timeCurrent timeNextDay secondsUntilNextDay returnState + timeCurrent="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second. + timeNextDay="$(date -d "$timeCurrent next day" --iso-8601=date)"; # Produce timestamp of beginning of tomorrow with resolution of 1 second. + secondsUntilNextDay="$(( $(date +%s -d "$timeNextDay") - $(date +%s -d "$timeCurrent") ))" ; # Calculate seconds until closest future midnight (res. 1 second). + if [[ "$secondsUntilNextDay" -gt 0 ]]; then + returnState="true"; + elif [[ "$secondsUntilNextDay" -eq 0 ]]; then + returnState="warning_zero"; + yell "WARNING:Reported time until next day exactly zero."; + elif [[ "$secondsUntilNextDay" -lt 0 ]]; then + returnState="warning_negative"; + yell "WARNING:Reported time until next day is negative."; + fi + + try echo "$secondsUntilNextDay"; # Report + + # Determine function return code + if [[ "$returnState" = "true" ]]; then + return 0; + elif [[ "$returnState" = "warning_zero" ]]; then + return 1; + elif [[ "$returnState" = "warning_negative" ]]; then + return 2; + fi +} # Report seconds until next day +timeUntilNextHour(){ + # Desc: Report seconds until next hour + # Version 1.0.1 + # Output: stdout: integer seconds until next hour + # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0 + # Usage: timeUntilNextHour + # Usage: if ! myTTL="$(timeUntilNextHour)"; then yell "ERROR in if statement"; exit 1; fi + + local returnState timeCurrent timeNextHour secondsUntilNextHour + timeCurrent="$(date --iso-8601=seconds)"; # Produce `date`-parsable current timestamp with resolution of 1 second. + timeNextHour="$(date -d "$timeCurrent next hour" --iso-8601=hours)"; # Produce `date`-parsable current time stamp with resolution of 1 second. + secondsUntilNextHour="$(( $(date +%s -d "$timeNextHour") - $(date +%s -d "$timeCurrent") ))"; # Calculate seconds until next hour (res. 1 second). + if [[ "$secondsUntilNextHour" -gt 0 ]]; then + returnState="true"; + elif [[ "$secondsUntilNextHour" -eq 0 ]]; then + returnState="warning_zero"; + yell "WARNING:Reported time until next hour exactly zero."; + elif [[ "$secondsUntilNextHour" -lt 0 ]]; then + returnState="warning_negative"; + yell "WARNING:Reported time until next hour is negative."; + fi; + + try echo "$secondsUntilNextHour"; # Report + + # Determine function return code + if [[ "$returnState" = "true" ]]; then + return 0; + elif [[ "$returnState" = "warning_zero" ]]; then + return 1; + elif [[ "$returnState" = "warning_negative" ]]; then + return 2; + fi; +} # Report seconds until next hour +validateInput() { + # Desc: Validates Input + # Usage: validateInput [str input] [str input type] + # Version: 0.3.1 + # Input: arg1: string to validate + # arg2: string specifying input type (ex:"ssh_pubkey") + # Output: return code 0: if input string matched specified string type + # Depends: bash 5, yell() + + local fn argInput argType + + # Save function name + fn="${FUNCNAME[0]}"; + + # Process arguments + argInput="$1"; + argType="$2"; + if [[ $# -gt 2 ]]; then yell "ERROR:$0:$fn:Too many arguments."; exit 1; fi; + + # Check for blank + if [[ -z "$argInput" ]]; then return 1; fi + + # Define input types + ## ssh_pubkey + ### Check for alnum/dash base64 (ex: "ssh-rsa AAAAB3NzaC1yc2EAAA") + if [[ "$argType" = "ssh_pubkey" ]]; then + if [[ "$argInput" =~ ^[[:alnum:]-]*[\ ]*[[:alnum:]+/=]*$ ]]; then + return 0; fi; fi; + + ## age_pubkey + ### Check for age1[:bech32:] + if [[ "$argType" = "age_pubkey" ]]; then + if [[ "$argInput" =~ ^age1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]*$ ]]; then + return 0; fi; fi + + ## integer + if [[ "$argType" = "integer" ]]; then + if [[ "$argInput" =~ ^[[:digit:]]*$ ]]; then + return 0; fi; fi; + + ## time element (year, month, week, day, hour, minute, second) + if [[ "$argType" = "time_element" ]]; then + if [[ "$argInput" = "year" ]] || \ + [[ "$argInput" = "month" ]] || \ + [[ "$argInput" = "week" ]] || \ + [[ "$argInput" = "day" ]] || \ + [[ "$argInput" = "hour" ]] || \ + [[ "$argInput" = "minute" ]] || \ + [[ "$argInput" = "second" ]]; then + return 0; fi; fi; + + # Return error if no condition matched. + return 1; +} # Validates strings magicInitWorkingDir() { # Desc: Determine temporary working directory from defaults or user input @@ -635,7 +796,8 @@ magicInitWorkingDir() { # Parse '-t' option (user-specified temporary working dir) ## Set dir_tmp_parent to user-specified value if specified local dir_tmp_parent - + + vbm "Starting magicInitWorkingDir() function."; if [[ "$optionTmpDir" = "true" ]]; then if [[ -d "$argTempDirPriority" ]]; then dir_tmp_parent="$argTempDirPriority"; @@ -657,6 +819,7 @@ magicInitWorkingDir() { fi; ## Set dir_tmp using dir_tmp_parent and nonce (scriptTimeStart) dir_tmp="$dir_tmp_parent"/"$scriptTimeStart""..bkgpslog" && vbm "DEBUG:Set dir_tmp to:$dir_tmp"; # Note: removed at end of main(). + vbm "Finished magicInitWorkingDir() function."; } # Sets working dir magicInitCheckTar() { # Desc: Initializes or checks output tar @@ -665,6 +828,7 @@ magicInitCheckTar() { # output: vars: pathout_tar # depends: Bash 5.0.3, vbm(), dateShort(), checkMakeTar(), magicWriteVersion() + vbm "Starting magicInitCheckTar() function."; # Form pathout_tar pathout_tar="$dirOut"/"$(dateShort "$(date --date="$bufferTTL seconds ago" --iso-8601=seconds)")".."$scriptHostname""$label""$cmd_compress_suffix""$cmd_encrypt_suffix".tar && \ vbm "STATUS:Set pathout_tar to:$pathout_tar"; @@ -672,25 +836,29 @@ magicInitCheckTar() { checkMakeTar "$pathout_tar"; ## Add VERSION file if checkMakeTar had to create a tar (exited 1) or replace one (exited 2) vbm "exit status before magicWriteVersion:$?" - if [[ $? -eq 1 ]] || [[ $? -eq 2 ]]; then magicWriteVersion; fi + if [[ $? -eq 1 ]] || [[ $? -eq 2 ]]; then magicWriteVersion; fi + vbm "Finished magicInitCheckTar() function."; } # Initialize tar, set pathout_tar magicParseCompressionArg() { # Desc: Parses compression arguments specified by '-c' option # Input: vars: optionCompress # Output: cmd_compress, cmd_compress_suffix # Depends: processArguments(), vbm(), checkapp(), gzip 1.9 + + vbm "Starting magicParseCompressionArg() function."; if [[ "$optionCompress" = "true" ]]; then # Check if compression option active if checkapp gzip; then # Check if gzip available cmd_compress="gzip " && vbm "cmd_compress:$cmd_compress"; cmd_compress_suffix=".gz" && vbm "cmd_compress_suffix:$cmd_compress_suffix"; else yell "ERROR:Compression enabled but \"gzip\" not found. Exiting."; exit 1; - fi + fi; else cmd_compress="tee /dev/null " && vbm "cmd_compress:$cmd_compress"; cmd_compress_suffix="" && vbm "cmd_compress_suffix:$cmd_compress_suffix"; vbm "DEBUG:Compression not enabled."; - fi + fi; + vbm "Starting magicParseCompressionArg() function."; } # Form compression cmd string and filename suffix magicParseCustomTTL() { # Desc: Set user-specified TTLs for buffer and script @@ -701,6 +869,7 @@ magicParseCustomTTL() { # Output: bufferTTL (integer), scriptTTL_TE (string) # Depends: Bash 5.0.3, yell(), vbm(), validateInput(), showUsage() + vbm "Starting magicParseCustomTTL() function."; # React to '-b, --buffer-ttl' option if [[ "$optionCustomBufferTTL" = "true" ]]; then ## T: Check if argCustomBufferTTL is an integer @@ -725,7 +894,8 @@ magicParseCustomTTL() { yell "ERROR:Invalid time element argument for custom script time-to-live."; showUsage; exit 1; fi; ## F: do not change scriptTTL_TE - fi; + fi; + vbm "Starting magicParseCustomTTL() function."; } # Sets custom script or buffer TTL if specified magicParseLabel() { # Desc: Parses -l option to set label @@ -756,6 +926,12 @@ magicParseProcessStrings() { local rawFileExt vbm "STATUS:Starting magicParseProcessStrings() function."; + vbm "var:optionProcString:$optionProcString"; + vbm "var:optionNoStoreRaw:$optionNoStoreRaw"; + vbm "var:optionStoreRaw:$optionStoreRaw"; + vbm "var:argRawFileExt:$argRawFileExt"; + vbm "ary:argProcStrings:${argProcStrings[*]}"; + vbm "ary:argProcFileExts:${argProcFileExts[*]}" # Validate input ## Validate argRawFileExt if [[ "$argRawFileExt" =~ ^[.][[:alnum:]]*$ ]]; then @@ -799,8 +975,8 @@ magicParseProcessStrings() { if [[ -z "$element" ]]; then yell "ERROR:Empty output file extension specified. Exiting."; exit 1; fi; done ## Make sure that no process string starts with '-' (ex: if only one arg supplied after '-p' option) for element in "${argProcStrings[@]}"; do - if [[ ! "$element" =~ ^[-][[:print:]]*$ ]] && [[ "$element" =~ ^[[:print:]]*$ ]]; then - yell "ERROR:Illegal character '-' at start of process string element. Option syntax error?"; + if [[ "$element" =~ ^[-][[:print:]]*$ ]] && [[ ! "$element" =~ ^[[:print:]]*$ ]]; then + yell "ERROR:Illegal character '-' at start of process string element:\"$element\""; exit 1; fi; done; vbm "STATUS:Quick check shows argProcStrings and argProcFileExts appear to have valid contents."; procStrings=("${argProcStrings[@]}"); # Export process command strings @@ -816,6 +992,7 @@ magicParseRecipientArgs() { # Depends: processArguments(), yell(), vbm(), checkapp(), checkAgePubkey(), validateInput() local recipients + vbm "Starting magicParseRecipientArgs() function."; # Check if encryption option active. if [[ "$optionEncrypt" = "true" ]] && [[ "$optionRecipients" = "true" ]]; then if checkapp age; then # Check that age is available. @@ -853,7 +1030,8 @@ magicParseRecipientArgs() { yell "ERROR:\\'-e\\' set but no \\'-r\\' or \\'-R\\' set."; exit 1; fi; # Catch case if '-r' or '-R' set but '-e' is not if [[ ! "$optionEncrypt" = "true" ]] && [[ "$optionRecipients" = "true" ]]; then - yell "ERROR:\\'-r\\' or \\'-R\\' set but \\'-e\\' is not set."; exit 1; fi; + yell "ERROR:\\'-r\\' or \\'-R\\' set but \\'-e\\' is not set."; exit 1; fi; + vbm "Finished magicParseRecipientArgs() function."; } # Populate recPubKeysValid with argRecPubKeys; form encryption cmd string and filename suffix magicParseRecipientDir() { # Desc: Updates recPubKeysValid with pubkeys in dir specified by '-R' option ("recipient directory") @@ -864,6 +1042,7 @@ magicParseRecipientDir() { local recipientDir recFileLine updateRecipients declare -a candRecPubKeysValid + vbm "Starting magicParseRecipientDir() function."; # Check that '-e' and '-R' set if [[ "$optionEncrypt" = "true" ]] && [[ "$optionRecDir" = "true" ]]; then ### Check that argRecDir is a directory. @@ -899,6 +1078,7 @@ magicParseRecipientDir() { # Handle case if '-R' set but '-e' not set if [[ ! "$optionEncrypt" = "true" ]] && [[ "$optionRecDir" = "true" ]]; then yell "ERROR: \\'-R\\' is set but \\'-e\\' is not set."; fi; + vbm "Finished magicParseRecipientDir() function."; } # Update recPubKeysValid with argRecDir magicSetScriptTTL() { #Desc: Sets script_TTL seconds from provided time_element string argument @@ -907,7 +1087,8 @@ magicSetScriptTTL() { #Output: var: scriptTTL (integer seconds) #Depends: timeUntilNextHour, timeUntilNextDay local argTimeElement - + + vbm "Starting magicSetScriptTTL() function."; argTimeElement="$1"; if [[ "$argTimeElement" = "day" ]]; then # Set script lifespan to end at start of next day @@ -930,6 +1111,7 @@ magicSetScriptTTL() { else yell "ERROR:Invalid argument for setScriptTTL function:$argTimeElement"; exit 1; fi; + vbm "Finished magicSetScriptTTL() function."; } # Set scriptTTL in seconds until next (day|hour). magicWriteVersion() { # Desc: Appends time-stamped VERSION to pathout_tar @@ -940,7 +1122,8 @@ magicWriteVersion() { # Output: appends tar (pathout_tar) # Depends: bash 5.0.3, dateTimeShort(), appendArgTar() local fileoutVersion contentVersion pubKeyIndex pubKeyIndex - + + vbm "Starting magicWriteVersion() function."; # Set VERSION file name fileoutVersion="$(dateTimeShort)..VERSION"; @@ -963,6 +1146,7 @@ magicWriteVersion() { # Write contentVersion as file fileoutVersion and write-append to pathout_tar appendArgTar "$contentVersion" "$fileoutVersion" "$pathout_tar" "$dir_tmp"; + vbm "Finished magicWriteVersion() function."; } # write version data to pathout_tar via appendArgTar() magicProcessWriteBuffer() { # Desc: process and write buffer @@ -1048,8 +1232,6 @@ main() { magicParseProcessStrings; # Sets arrays: procStrings, procFileExts ## React to "-l" (output file label) option magicParseLabel; # sets label (ex: "_location") - ## React to "-w" (how to name raw stdin file) option - magicParseStoreRaw; # sets raw_suffix # Perform secondary setup operations ## Set script lifespan (scriptTTL from scriptTTL_TE) @@ -1069,16 +1251,12 @@ main() { # MAIN LOOP: Run until script TTL seconds pass bufferRound=0; while [[ $SECONDS -lt "scriptTTL" ]]; do + vbm "DEBUG:Starting buffer round:$bufferRound"; bufferTOD="$((SECONDS + bufferTTL))"; # Set buffer round time-of-death - lineCount=0; # Debug counter # Consume stdin to fill buffer until buffer time-of-death (TOD) arrives while read -r -t "$bufferTTL" line && [[ $SECONDS -lt "$bufferTOD" ]]; do # Append line to buffer array buffer+=("$line"); - echo "DEBUG:Processing line:$lineCount"; - echo "DEBUG:Current line :$line"; - echo "DEBUG:buf elem count :${#buffer[@]}"; - ((lineCount++)); done; # Create dir_tmp if missing if ! [[ -d "$dir_tmp" ]]; then yell "ERROR:dir_tmp existence failure:$dir_tmp"; try mkdir "$dir_tmp" && vbm "DEBUG:Working dir recreated dir_tmp:$dir_tmp"; fi