LXR linux/fs/ecryptfs/debug.c

   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/**
   3 * eCryptfs: Linux filesystem encryption layer
   4 * Functions only useful for debugging.
   5 *
   6 * Copyright (C) 2006 International Business Machines Corp.
   7 *   Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
   8 */
   9
  10#include "ecryptfs_kernel.h"
  11
  12/**
  13 * ecryptfs_dump_auth_tok - debug function to print auth toks
  14 *
  15 * This function will print the contents of an ecryptfs authentication
  16 * token.
  17 */
  18void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok)
  19{
  20        char salt[ECRYPTFS_SALT_SIZE * 2 + 1];
  21        char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
  22
  23        ecryptfs_printk(KERN_DEBUG, "Auth tok at mem loc [%p]:\n",
  24                        auth_tok);
  25        if (auth_tok->flags & ECRYPTFS_PRIVATE_KEY) {
  26                ecryptfs_printk(KERN_DEBUG, " * private key type\n");
  27        } else {
  28                ecryptfs_printk(KERN_DEBUG, " * passphrase type\n");
  29                ecryptfs_to_hex(salt, auth_tok->token.password.salt,
  30                                ECRYPTFS_SALT_SIZE);
  31                salt[ECRYPTFS_SALT_SIZE * 2] = '\0';
  32                ecryptfs_printk(KERN_DEBUG, " * salt = [%s]\n", salt);
  33                if (auth_tok->token.password.flags &
  34                    ECRYPTFS_PERSISTENT_PASSWORD) {
  35                        ecryptfs_printk(KERN_DEBUG, " * persistent\n");
  36                }
  37                memcpy(sig, auth_tok->token.password.signature,
  38                       ECRYPTFS_SIG_SIZE_HEX);
  39                sig[ECRYPTFS_SIG_SIZE_HEX] = '\0';
  40                ecryptfs_printk(KERN_DEBUG, " * signature = [%s]\n", sig);
  41        }
  42        ecryptfs_printk(KERN_DEBUG, " * session_key.flags = [0x%x]\n",
  43                        auth_tok->session_key.flags);
  44        if (auth_tok->session_key.flags
  45            & ECRYPTFS_USERSPACE_SHOULD_TRY_TO_DECRYPT)
  46                ecryptfs_printk(KERN_DEBUG,
  47                                " * Userspace decrypt request set\n");
  48        if (auth_tok->session_key.flags
  49            & ECRYPTFS_USERSPACE_SHOULD_TRY_TO_ENCRYPT)
  50                ecryptfs_printk(KERN_DEBUG,
  51                                " * Userspace encrypt request set\n");
  52        if (auth_tok->session_key.flags & ECRYPTFS_CONTAINS_DECRYPTED_KEY) {
  53                ecryptfs_printk(KERN_DEBUG, " * Contains decrypted key\n");
  54                ecryptfs_printk(KERN_DEBUG,
  55                                " * session_key.decrypted_key_size = [0x%x]\n",
  56                                auth_tok->session_key.decrypted_key_size);
  57                ecryptfs_printk(KERN_DEBUG, " * Decrypted session key "
  58                                "dump:\n");
  59                if (ecryptfs_verbosity > 0)
  60                        ecryptfs_dump_hex(auth_tok->session_key.decrypted_key,
  61                                          ECRYPTFS_DEFAULT_KEY_BYTES);
  62        }
  63        if (auth_tok->session_key.flags & ECRYPTFS_CONTAINS_ENCRYPTED_KEY) {
  64                ecryptfs_printk(KERN_DEBUG, " * Contains encrypted key\n");
  65                ecryptfs_printk(KERN_DEBUG,
  66                                " * session_key.encrypted_key_size = [0x%x]\n",
  67                                auth_tok->session_key.encrypted_key_size);
  68                ecryptfs_printk(KERN_DEBUG, " * Encrypted session key "
  69                                "dump:\n");
  70                if (ecryptfs_verbosity > 0)
  71                        ecryptfs_dump_hex(auth_tok->session_key.encrypted_key,
  72                                          auth_tok->session_key.
  73                                          encrypted_key_size);
  74        }
  75}
  76
  77/**
  78 * ecryptfs_dump_hex - debug hex printer
  79 * @data: string of bytes to be printed
  80 * @bytes: number of bytes to print
  81 *
  82 * Dump hexadecimal representation of char array
  83 */
  84void ecryptfs_dump_hex(char *data, int bytes)
  85{
  86        if (ecryptfs_verbosity < 1)
  87                return;
  88
  89        print_hex_dump(KERN_DEBUG, "ecryptfs: ", DUMP_PREFIX_OFFSET, 16, 1,
  90                       data, bytes, false);
  91}
  92