Move artifactory authentication redaction code into its own function: redact_sensitive()

3 files changed, 74 insertions, 13 deletions

diff --git a/include/utils.h b/include/utils.h
index 61f5948..37ba50a 100644
--- a/include/utils.h
+++ b/include/utils.h
@@ -265,4 +265,47 @@ int fix_tox_conf(const char *filename, char **result);
 
 char *collapse_whitespace(char **s);
 
+/**
+ * Write ***REDACTED*** in dest for each occurrence of to_redacted token present in src
+ *
+ * ```c
+ * char command[PATH_MAX] = {0};
+ * char command_redacted[PATH_MAX] = {0};
+ * const char *password = "abc123";
+ * const char *host = "myhostname";
+ * const char *to_redact_case1[] = {password, host, NULL};
+ * const char *to_redact_case2[] = {password, "--host", NULL};
+ * const char *to_redact_case3[] = {password, "--host", host, NULL};
+ *
+ * sprintf(command, "echo %s | program --host=%s -", password, host);
+ *
+ * // CASE 1
+ * redact_sensitive(to_redact_case1, command, command_redacted, sizeof(command_redacted) - 1);
+ * printf("executing: %s\n", command_redacted);
+ * // User sees:
+ * // executing: echo ***REDACTED*** | program --host=***REDACTED*** -
+ * system(command);
+ *
+ * // CASE 2 remove an entire argument
+ * redact_sensitive(to_redact_case2, command, command_redacted, sizeof(command_redacted) - 1);
+ * printf("executing: %s\n", command_redacted);
+ * // User sees:
+ * // executing: echo ***REDACTED*** | program ***REDACTED*** -
+ * system(command);
+ *
+ * // CASE 3 remove it all (noisy)
+ * redact_sensitive(to_redact_case3, command, command_redacted, sizeof(command_redacted) - 1);
+ * printf("executing: %s\n", command_redacted);
+ * // User sees:
+ * // executing: echo ***REDACTED*** | program ***REDACTED***=***REDACTED*** -
+ * system(command);
+ * ```
+ *
+ * @param to_redact array of tokens to redact
+ * @param src input string
+ * @param dest output string
+ * @param maxlen maximum length of dest byte array
+ * @return 0 on success, -1 on error
+ */
+int redact_sensitive(const char **to_redact, char *src, char *dest, size_t maxlen);
 #endif //OMC_UTILS_H
diff --git a/src/artifactory.c b/src/artifactory.c
index 437912d..a23af98 100644
--- a/src/artifactory.c
+++ b/src/artifactory.c
@@ -224,9 +224,6 @@ int jfrog_cli(struct JFRT_Auth *auth, char *args) {
         return -1;
     }
 
-    snprintf(cmd, sizeof(cmd) - 1, "jf %s %s", args, auth_args);
-    strcpy(cmd_redacted, cmd);
-
     const char *redactable[] = {
             "--access-token=",
             "--ssh-key-path=",
@@ -236,16 +233,9 @@ int jfrog_cli(struct JFRT_Auth *auth, char *args) {
             "--password=",
             NULL,
     };
-    for (size_t i = 0; redactable[i] != NULL; i++) {
-        char *thing = strstr(cmd_redacted, redactable[i]);
-        if (thing) {
-            thing += strlen(redactable[i]);
-            while (*thing != '\0' && !isspace(*thing)) {
-                *thing = 'x';
-                ++thing;
-            }
-        }
-    }
+    snprintf(cmd, sizeof(cmd) - 1, "jf %s %s", args, auth_args);
+    redact_sensitive(redactable, cmd, cmd_redacted, sizeof(cmd_redacted) - 1);
+
     guard_free(auth_args);
     guard_strlist_free(&arg_map);
 
diff --git a/src/utils.c b/src/utils.c
index d24e32d..d41400e 100644
--- a/src/utils.c
+++ b/src/utils.c
@@ -686,3 +686,31 @@ char *collapse_whitespace(char **s) {
 
     return *s;
 }
+
+int redact_sensitive(const char **to_redact, char *src, char *dest, size_t maxlen) {
+    char **parts = split(src, " ", 0);
+    if (!parts) {
+        fprintf(stderr, "Unable to split source string\n");
+        return -1;
+    }
+
+    for (size_t i = 0; to_redact[i] != NULL; i++) {
+        for (size_t p = 0; parts[p] != NULL; p++) {
+            if (strstr(parts[p], to_redact[i])) {
+                replace_text(parts[p], to_redact[i], "***REDACTED***", REPLACE_TRUNCATE_AFTER_MATCH);
+            }
+        }
+    }
+
+    char *dest_tmp = join(parts, " ");
+    if (!dest_tmp) {
+        fprintf(stderr, "Unable to join message array\n");
+        return -1;
+    }
+    strncpy(dest, dest_tmp, maxlen);
+
+    GENERIC_ARRAY_FREE(parts);
+    guard_free(dest_tmp);
+    return 0;
+}
+