[BK-2020-03.git] / user / bk-gpg-ver-sigs

#!/usr/bin/env bash
# Desc: Runs gpg --verify on all .asc, .gpg, and .sig files in specified directory.
# Version: 0.0.1
# Depends: GNU parallel 20210822
# Assumes: File names do not contain newlines.

declare -Ag appRollCall # Associative array for storing app status
declare -Ag fileRollCall # Associative array for storing file status
declare -Ag dirRollCall # Associative array for storing dir status
find_pat_regex=".+\(sig\|asc\|gpg\)$";
find_depth="10";

yell() { echo "$0: $*" >&2; } # print script path and all args to stderr
die() { yell "$*"; exit 111; } # same as yell() but non-zero exit status
must() { "$@" || die "cannot $*"; } # runs args as command, reports args if command fails
checkapp() {
    # Desc: If arg is a command, save result in assoc array 'appRollCall'
    # Usage: checkapp arg1 arg2 arg3 ...
    # Version: 0.1.1
    # Input: global assoc. array 'appRollCall'
    # Output: adds/updates key(value) to global assoc array 'appRollCall'
    # Depends: bash 5.0.3
    local returnState    

    #===Process Args===
    for arg in "$@"; do
	if command -v "$arg" 1>/dev/null 2>&1; then # Check if arg is a valid command
	    appRollCall[$arg]="true";
	    if ! [ "$returnState" = "false" ]; then returnState="true"; fi;
	else
	    appRollCall[$arg]="false"; returnState="false";
	fi;
    done;

    #===Determine function return code===
    if [ "$returnState" = "true" ]; then
	return 0;
    else
	return 1;
    fi;
} # Check that app exists
checkfile() {
    # Desc: If arg is a file path, save result in assoc array 'fileRollCall'
    # Usage: checkfile arg1 arg2 arg3 ...
    # Version: 0.1.2
    # Input: global assoc. array 'fileRollCall'
    # Output: adds/updates key(value) to global assoc array 'fileRollCall';
    # Output: returns 0 if app found, 1 otherwise
    # Depends: bash 5.0.3
    local returnState

    #===Process Args===
    for arg in "$@"; do
	if [ -f "$arg" ]; then
	    fileRollCall["$arg"]="true";
	    if ! [ "$returnState" = "false" ]; then returnState="true"; fi;
        elif [ -z "$arg" ]; then
            fileRollCall["(no name)"]="false"; returnState="false";
	else
	    fileRollCall["$arg"]="false"; returnState="false";
	fi;
    done;
    
    #===Determine function return code===
    if [ "$returnState" = "true" ]; then
	return 0;
    else
	return 1;
    fi;
} # Check that file exists
checkdir() {
    # Desc: If arg is a dir path, save result in assoc array 'dirRollCall'
    # Usage: checkdir arg1 arg2 arg3 ...
    # Version 0.1.2
    # Input: global assoc. array 'dirRollCall'
    # Output: adds/updates key(value) to global assoc array 'dirRollCall';
    # Output: returns 0 if all args are dirs; 1 otherwise
    # Depends: Bash 5.0.3
    local returnState

    #===Process Args===
    for arg in "$@"; do
	if [ -z "$arg" ]; then
	    dirRollCall["(Unspecified Dirname(s))"]="false"; returnState="false";
	elif [ -d "$arg" ]; then
	    dirRollCall["$arg"]="true";
	    if ! [ "$returnState" = "false" ]; then returnState="true"; fi
	else
	    dirRollCall["$arg"]="false"; returnState="false";
	fi
    done
    
    #===Determine function return code===
    if [ "$returnState" = "true" ]; then
	return 0;
    else
	return 1;
    fi
} # Check that dir exists
displayMissing() {
    # Desc: Displays missing apps, files, and dirs
    # Usage: displayMissing
    # Version 1.0.0
    # Input: associative arrays: appRollCall, fileRollCall, dirRollCall
    # Output: stderr: messages indicating missing apps, file, or dirs
    # Output: returns exit code 0 if nothing missing; 1 otherwise
    # Depends: bash 5, checkAppFileDir()
    local missingApps value appMissing missingFiles fileMissing
    local missingDirs dirMissing

    #==BEGIN Display errors==
    #===BEGIN Display Missing Apps===
    missingApps="Missing apps  :";
    #for key in "${!appRollCall[@]}"; do echo "DEBUG:$key => ${appRollCall[$key]}"; done
    for key in "${!appRollCall[@]}"; do
	value="${appRollCall[$key]}";
	if [ "$value" = "false" ]; then
	    #echo "DEBUG:Missing apps: $key => $value";
	    missingApps="$missingApps""$key ";
	    appMissing="true";
	fi;
    done;
    if [ "$appMissing" = "true" ]; then  # Only indicate if an app is missing.
	echo "$missingApps" 1>&2;
    fi;
    unset value;
    #===END Display Missing Apps===

    #===BEGIN Display Missing Files===
    missingFiles="Missing files:";
    #for key in "${!fileRollCall[@]}"; do echo "DEBUG:$key => ${fileRollCall[$key]}"; done
    for key in "${!fileRollCall[@]}"; do
	value="${fileRollCall[$key]}";
	if [ "$value" = "false" ]; then
	    #echo "DEBUG:Missing files: $key => $value";
	    missingFiles="$missingFiles""$key ";
	    fileMissing="true";
	fi;
    done;
    if [ "$fileMissing" = "true" ]; then  # Only indicate if an app is missing.
	echo "$missingFiles" 1>&2;
    fi;
    unset value;
    #===END Display Missing Files===

    #===BEGIN Display Missing Directories===
    missingDirs="Missing dirs:";
    #for key in "${!dirRollCall[@]}"; do echo "DEBUG:$key => ${dirRollCall[$key]}"; done
    for key in "${!dirRollCall[@]}"; do
	value="${dirRollCall[$key]}";
	if [ "$value" = "false" ]; then
	    #echo "DEBUG:Missing dirs: $key => $value";
	    missingDirs="$missingDirs""$key ";
	    dirMissing="true";
	fi;
    done;
    if [ "$dirMissing" = "true" ]; then  # Only indicate if an dir is missing.
	echo "$missingDirs" 1>&2;
    fi;
    unset value;
    #===END Display Missing Directories===

    #==END Display errors==
    #==BEGIN Determine function return code===
    if [ "$appMissing" == "true" ] || [ "$fileMissing" == "true" ] || [ "$dirMissing" == "true" ]; then
	return 1;
    else
	return 0;
    fi
    #==END Determine function return code===
} # Display missing apps, files, dirs
verify_file() {
    # input: arg1: file path
    path_in="$1"

    # Verify sig file
    if gpg --verify "$path_in" 1>&2 2>/dev/random; then
        printf "STATUS:Good sig for:%s\n" "$path_in";
    else
        printf "STATUS:Bad sig for :%s\n" "$path_in";
    fi;
}; # verfiies one gpg file
main() {
    # Check args
    ## Note: Assume a single arg that is a dir
    if [[ ! $# -eq 1 ]]; then die "FATAL:Incorrect number of args (must be 1):$#"; fi;
    if [[ ! -d "$1" ]]; then die "FATAL:Not a dir:$1"; fi;
    
    # Check apps
    if ! checkapp find gpg parallel; then displayMissing; printf "FATAL:Missing apps."; exit 1; fi;

    # Export bash functions (for GNU parallel)
    export -f yell die must verify_file;

    # Generate file list
    list_paths="$( find "$1" -maxdepth "$find_depth" -type f -iregex "$find_pat_regex" )";

    # Verify files
    echo "$list_paths" | parallel --group verify_file '{}';
};  # main program

main "$@";

exit 0;

#    find "$1" -maxdepth "$find_depth" -type f -iregex "find_pat_regex" | parallel if gpg --verify '{}' 2>/dev/random \; then echo "STATUS:Good sig:" '{}' \; else echo "STATUS:Bad sig :" '{}' \; fi\;
Commit	Line	Data
849106f7 SBS	1	#!/usr/bin/env bash
	2	# Desc: Runs gpg --verify on all .asc, .gpg, and .sig files in specified directory.
	3	# Version: 0.0.1
	4	# Depends: GNU parallel 20210822
	5	# Assumes: File names do not contain newlines.
	6
	7	declare -Ag appRollCall # Associative array for storing app status
	8	declare -Ag fileRollCall # Associative array for storing file status
	9	declare -Ag dirRollCall # Associative array for storing dir status
	10	find_pat_regex=".+\(sig\\|asc\\|gpg\)$";
	11	find_depth="10";
	12
	13	yell() { echo "$0: $*" >&2; } # print script path and all args to stderr
	14	die() { yell "$*"; exit 111; } # same as yell() but non-zero exit status
	15	must() { "$@" \|\| die "cannot $*"; } # runs args as command, reports args if command fails
	16	checkapp() {
	17	# Desc: If arg is a command, save result in assoc array 'appRollCall'
	18	# Usage: checkapp arg1 arg2 arg3 ...
	19	# Version: 0.1.1
	20	# Input: global assoc. array 'appRollCall'
	21	# Output: adds/updates key(value) to global assoc array 'appRollCall'
	22	# Depends: bash 5.0.3
	23	local returnState
	24
	25	#===Process Args===
	26	for arg in "$@"; do
	27	if command -v "$arg" 1>/dev/null 2>&1; then # Check if arg is a valid command
	28	appRollCall[$arg]="true";
	29	if ! [ "$returnState" = "false" ]; then returnState="true"; fi;
	30	else
	31	appRollCall[$arg]="false"; returnState="false";
	32	fi;
	33	done;
	34
	35	#===Determine function return code===
	36	if [ "$returnState" = "true" ]; then
	37	return 0;
	38	else
	39	return 1;
	40	fi;
	41	} # Check that app exists
	42	checkfile() {
	43	# Desc: If arg is a file path, save result in assoc array 'fileRollCall'
	44	# Usage: checkfile arg1 arg2 arg3 ...
	45	# Version: 0.1.2
	46	# Input: global assoc. array 'fileRollCall'
	47	# Output: adds/updates key(value) to global assoc array 'fileRollCall';
	48	# Output: returns 0 if app found, 1 otherwise
	49	# Depends: bash 5.0.3
	50	local returnState
	51
	52	#===Process Args===
	53	for arg in "$@"; do
	54	if [ -f "$arg" ]; then
	55	fileRollCall["$arg"]="true";
	56	if ! [ "$returnState" = "false" ]; then returnState="true"; fi;
	57	elif [ -z "$arg" ]; then
	58	fileRollCall["(no name)"]="false"; returnState="false";
	59	else
	60	fileRollCall["$arg"]="false"; returnState="false";
	61	fi;
	62	done;
	63
	64	#===Determine function return code===
65	if [ "$returnState" = "true" ]; then
66	return 0;
67	else
68	return 1;
69	fi;
70	} # Check that file exists
71	checkdir() {
72	# Desc: If arg is a dir path, save result in assoc array 'dirRollCall'
73	# Usage: checkdir arg1 arg2 arg3 ...
74	# Version 0.1.2
75	# Input: global assoc. array 'dirRollCall'
76	# Output: adds/updates key(value) to global assoc array 'dirRollCall';
77	# Output: returns 0 if all args are dirs; 1 otherwise
78	# Depends: Bash 5.0.3
79	local returnState
80
81	#===Process Args===
82	for arg in "$@"; do
83	if [ -z "$arg" ]; then
84	dirRollCall["(Unspecified Dirname(s))"]="false"; returnState="false";
85	elif [ -d "$arg" ]; then
86	dirRollCall["$arg"]="true";
87	if ! [ "$returnState" = "false" ]; then returnState="true"; fi
88	else
89	dirRollCall["$arg"]="false"; returnState="false";
90	fi
91	done
92
93	#===Determine function return code===
94	if [ "$returnState" = "true" ]; then
95	return 0;
96	else
97	return 1;
98	fi
99	} # Check that dir exists
100	displayMissing() {
101	# Desc: Displays missing apps, files, and dirs
102	# Usage: displayMissing
103	# Version 1.0.0
104	# Input: associative arrays: appRollCall, fileRollCall, dirRollCall
105	# Output: stderr: messages indicating missing apps, file, or dirs
106	# Output: returns exit code 0 if nothing missing; 1 otherwise
107	# Depends: bash 5, checkAppFileDir()
108	local missingApps value appMissing missingFiles fileMissing
109	local missingDirs dirMissing
110
111	#==BEGIN Display errors==
112	#===BEGIN Display Missing Apps===
113	missingApps="Missing apps :";
114	#for key in "${!appRollCall[@]}"; do echo "DEBUG:$key => ${appRollCall[$key]}"; done
115	for key in "${!appRollCall[@]}"; do
116	value="${appRollCall[$key]}";
117	if [ "$value" = "false" ]; then
118	#echo "DEBUG:Missing apps: $key => $value";
119	missingApps="$missingApps""$key ";
120	appMissing="true";
121	fi;
122	done;
123	if [ "$appMissing" = "true" ]; then # Only indicate if an app is missing.
124	echo "$missingApps" 1>&2;
125	fi;
126	unset value;
127	#===END Display Missing Apps===
128
129	#===BEGIN Display Missing Files===
130	missingFiles="Missing files:";
131	#for key in "${!fileRollCall[@]}"; do echo "DEBUG:$key => ${fileRollCall[$key]}"; done
132	for key in "${!fileRollCall[@]}"; do
133	value="${fileRollCall[$key]}";
134	if [ "$value" = "false" ]; then
135	#echo "DEBUG:Missing files: $key => $value";
136	missingFiles="$missingFiles""$key ";
137	fileMissing="true";
138	fi;
139	done;
140	if [ "$fileMissing" = "true" ]; then # Only indicate if an app is missing.
141	echo "$missingFiles" 1>&2;
142	fi;
143	unset value;
144	#===END Display Missing Files===
145
146	#===BEGIN Display Missing Directories===
147	missingDirs="Missing dirs:";
148	#for key in "${!dirRollCall[@]}"; do echo "DEBUG:$key => ${dirRollCall[$key]}"; done
149	for key in "${!dirRollCall[@]}"; do
150	value="${dirRollCall[$key]}";
151	if [ "$value" = "false" ]; then
152	#echo "DEBUG:Missing dirs: $key => $value";
153	missingDirs="$missingDirs""$key ";
154	dirMissing="true";
155	fi;
156	done;
157	if [ "$dirMissing" = "true" ]; then # Only indicate if an dir is missing.
158	echo "$missingDirs" 1>&2;
159	fi;
160	unset value;
161	#===END Display Missing Directories===
162
163	#==END Display errors==
164	#==BEGIN Determine function return code===
165	if [ "$appMissing" == "true" ] \|\| [ "$fileMissing" == "true" ] \|\| [ "$dirMissing" == "true" ]; then
166	return 1;
167	else
168	return 0;
169	fi
170	#==END Determine function return code===
171	} # Display missing apps, files, dirs
172	verify_file() {
173	# input: arg1: file path
174	path_in="$1"
175
176	# Verify sig file
177	if gpg --verify "$path_in" 1>&2 2>/dev/random; then
178	printf "STATUS:Good sig for:%s\n" "$path_in";
179	else
180	printf "STATUS:Bad sig for :%s\n" "$path_in";
181	fi;
182	}; # verfiies one gpg file
183	main() {
184	# Check args
185	## Note: Assume a single arg that is a dir
186	if [[ ! $# -eq 1 ]]; then die "FATAL:Incorrect number of args (must be 1):$#"; fi;
187	if [[ ! -d "$1" ]]; then die "FATAL:Not a dir:$1"; fi;
188
189	# Check apps
190	if ! checkapp find gpg parallel; then displayMissing; printf "FATAL:Missing apps."; exit 1; fi;
191
192	# Export bash functions (for GNU parallel)
193	export -f yell die must verify_file;
194
195	# Generate file list
196	list_paths="$( find "$1" -maxdepth "$find_depth" -type f -iregex "$find_pat_regex" )";
197
198	# Verify files
199	echo "$list_paths" \| parallel --group verify_file '{}';
200	}; # main program
201
202	main "$@";
203
204	exit 0;
205
206	# find "$1" -maxdepth "$find_depth" -type f -iregex "find_pat_regex" \| parallel if gpg --verify '{}' 2>/dev/random \; then echo "STATUS:Good sig:" '{}' \; else echo "STATUS:Bad sig :" '{}' \; fi\;