homedir.h File Reference

Temporary GPG homedir management for isolated key operations. More...

Go to the source code of this file.

Typedefs
typedef struct gpg_homedir	gpg_homedir_t

Functions
gpg_homedir_t *	gpg_homedir_create (void)
	Create a temporary GPG homedir for isolated key operations.
const char *	gpg_homedir_path (const gpg_homedir_t *homedir)
	Get the homedir path for use in GPG commands.
void	gpg_homedir_destroy (gpg_homedir_t *homedir)
	Destroy a temporary GPG homedir and clean up all files.

Detailed Description

Temporary GPG homedir management for isolated key operations.

Provides utilities for creating and managing temporary GPG homedirs to isolate key operations (import, decrypt, sign) without polluting the user's main GPG keyring.

Using a temporary homedir provides:

• Isolation from user's keys (no risk of deleting wrong keys)
• Automatic cleanup (just delete the directory)
• Better error handling and race condition avoidance
• Cleaner, more maintainable code

Example usage:

gpg_homedir_t homedir = gpg_homedir_create();
if (homedir == NULL) {
  return SET_ERRNO(ERROR_CRYPTO_KEY, "Failed to create GPG homedir");
}
 
// Use homedir.path in gpg commands
char cmd[1024];
snprintf(cmd, sizeof(cmd), "gpg --homedir '%s' --batch --import '%s'",
         homedir->path, key_file);
 
int status = system(cmd);
gpg_homedir_destroy(homedir);

Definition in file homedir.h.

Typedef Documentation

gpg_homedir_t

typedef struct gpg_homedir gpg_homedir_t

Definition at line 46 of file homedir.h.

Function Documentation

gpg_homedir_create()

gpg_homedir_t * gpg_homedir_create

(

void

)

Create a temporary GPG homedir for isolated key operations.

Creates a new temporary directory configured for GPG use. The directory is isolated from the user's main GPG keyring.

Returns

Pointer to homedir handle on success, NULL on failure Caller must destroy with gpg_homedir_destroy()

Note

The directory is created in the system temp location (TMPDIR, /tmp, etc.)

Definition at line 22 of file homedir.c.

                                        {
  gpg_homedir_t *homedir = SAFE_MALLOC(sizeof(gpg_homedir_t), gpg_homedir_t *);
  if (!homedir) {
    log_error("Failed to allocate memory for GPG homedir handle");
    return NULL;
  }
 
  /* Create temporary directory using platform abstraction */
  if (platform_mkdtemp(homedir->path, sizeof(homedir->path), "ascii-chat-gpg") != 0) {
    log_error("Failed to create temporary GPG homedir");
    SAFE_FREE(homedir);
    return NULL;
  }
 
  /* Restrict permissions to owner only (mode 0700) using platform abstraction */
  if (platform_chmod(homedir->path, 0700) != 0) {
    log_warn("Failed to set permissions on GPG homedir, attempting cleanup");
    platform_rmdir_recursive(homedir->path);
    SAFE_FREE(homedir);
    return NULL;
  }
 
  log_debug("Created temporary GPG homedir: %s", homedir->path);
  return homedir;
}

References log_debug, log_error, log_warn, platform_chmod(), platform_mkdtemp(), platform_rmdir_recursive(), SAFE_FREE, and SAFE_MALLOC.

gpg_homedir_destroy()

void gpg_homedir_destroy

(

gpg_homedir_t *

homedir

)

Destroy a temporary GPG homedir and clean up all files.

Recursively deletes the temporary directory and all its contents. Safe to call on NULL pointer (no-op).

Parameters

homedir

Handle from gpg_homedir_create() (can be NULL)

Definition at line 55 of file homedir.c.

                                                 {
  if (!homedir) {
    return;
  }
 
  /* Recursively delete the entire directory and all contents using platform abstraction */
  if (platform_rmdir_recursive(homedir->path) != 0) {
    log_warn("Failed to completely clean up GPG homedir: %s", homedir->path);
  } else {
    log_debug("Cleaned up temporary GPG homedir: %s", homedir->path);
  }
 
  SAFE_FREE(homedir);
}

References log_debug, log_warn, platform_rmdir_recursive(), and SAFE_FREE.

gpg_homedir_path()

const char * gpg_homedir_path

(

const gpg_homedir_t *

homedir

)

Get the homedir path for use in GPG commands.

Returns the filesystem path of the temporary homedir. This path should be used with gpg's –homedir flag.

Parameters

homedir

Handle from gpg_homedir_create()

Returns

Pointer to path string (valid until gpg_homedir_destroy() is called) Returns NULL if homedir is invalid

Definition at line 48 of file homedir.c.

                                                           {
  if (!homedir) {
    return NULL;
  }
  return homedir->path;
}