All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] dmsetup: improve message command
@ 2016-02-26 11:42 Werner Koch
  2016-03-18 11:06 ` Werner Koch
  0 siblings, 1 reply; 5+ messages in thread
From: Werner Koch @ 2016-02-26 11:42 UTC (permalink / raw)
  To: dm-devel

[-- Attachment #1: Type: text/plain, Size: 390 bytes --]

Hi!

I am playing with a new crypto container format and propose to enhance
"dmsetup message" to accept the actual message from stdin instead of
taking it only from the command line.  This is useful to set a key and
similar to how "dmsetup create" is reading the table from stdin.

Patch attached.


Shalom-Salam,

   Werner

-- 
Die Gedanken sind frei.  Ausnahmen regelt ein Bundesgesetz.

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-dmsetup-command-message-may-now-read-the-message-fro.patch --]
[-- Type: text/x-diff, Size: 4737 bytes --]

From ae2b5739007b0829c3a142d0d5e782b3b7fe3028 Mon Sep 17 00:00:00 2001
From: Werner Koch <wk@gnupg.org>
Date: Fri, 19 Feb 2016 21:47:45 +0100
Subject: [PATCH] dmsetup: command message may now read the message from stdin.

When "dmsetup messsage" is used to set an encryption key it is better
to read that from stdin so that the key does not show up in ps or the
shell history.  Thus instead of an error message when the third arg is
missing, it is now taken from stdin.  stdin is also switched to
unbuffered mode so that sensitive data should not end up in stdio
buffers.  A new wipememory macro (taken from GnuPG) is used to
securely erase the message from memory.

Signed-off-by: Werner Koch <wk@gnupg.org>
---
 man/dmsetup.8.in |  5 +++--
 tools/dmsetup.c  | 68 ++++++++++++++++++++++++++++++++++++++++++--------------
 2 files changed, 54 insertions(+), 19 deletions(-)

diff --git a/man/dmsetup.8.in b/man/dmsetup.8.in
index f92dbe5..c9c886a 100644
--- a/man/dmsetup.8.in
+++ b/man/dmsetup.8.in
@@ -127,7 +127,7 @@ dmsetup \(em low level logical volume management
 .  BR message
 .  IR device_name
 .  IR sector
-.  IR message
+.  RI [ message ]
 ..
 .CMD_MESSAGE
 .
@@ -714,7 +714,8 @@ reactivating it with proper mangling mode used (see also \fB\-\-manglename\fP).
 .HP
 .CMD_MESSAGE
 .br
-Send message to target. If sector not needed use 0.
+Send message to target. If sector not needed use 0.  If the message
+argument is not given, the first line read from stdin is used.
 .
 .HP
 .CMD_MKNODES
diff --git a/tools/dmsetup.c b/tools/dmsetup.c
index 4db6004..8e988f0 100644
--- a/tools/dmsetup.c
+++ b/tools/dmsetup.c
@@ -105,6 +105,15 @@ extern char *optarg;
 
 #define err(msg, x...) fprintf(stderr, msg "\n", ##x)
 
+/* To avoid that a compiler optimizes memset calls away, this macro
+ * should be used securely clear memory. */
+#define wipememory(_ptr,_len) do { \
+              volatile char *_vptr=(volatile char *)(_ptr); \
+              size_t _vlen=(_len); \
+              while(_vlen) { *_vptr=0; _vptr++; _vlen--; } \
+                  } while(0)
+
+
 /* program_id used for dmstats-managed statistics regions */
 #define DM_STATS_PROGRAM_ID "dmstats"
 
@@ -1234,25 +1243,50 @@ static int _message(CMD_ARGS)
 	argc--;
 	argv++;
 
-	if (argc <= 0)
-		err("No message supplied.\n");
-
-	for (i = 0; i < argc; i++)
-		sz += strlen(argv[i]) + 1;
-
-	if (!(str = dm_zalloc(sz))) {
-		err("message string allocation failed");
-		goto out;
-	}
-
-	for (i = 0; i < argc; i++) {
-		if (i)
-			strcat(str, " ");
-		strcat(str, argv[i]);
-	}
+	if (argc <= 0) {
+		/* Read messsage from stdin (one line).  */
+                size_t len = LINE_SIZE;
+
+                /* Try avoiding storing potential sensitive data in a
+                 * stdio buffer.  */
+                if (setvbuf (stdin, NULL, _IONBF, BUFSIZ)) {
+                        err("Failed to switch stdin to unbuffered mode.");
+                        goto out;
+                }
+
+                if (!(str = dm_malloc(len))) {
+                        err("Failed to malloc line buffer.");
+                        goto out;
+                }
+
+                if (!fgets(str, (int) len, stdin)) {
+                        err("Error reading line from stdin.");
+                        dm_free(str);
+                        goto out;
+                }
+                len = strlen (str);
+                if (len && str[len-1]=='\n')
+                        str[--len] = 0;
+
+        } else {
+                for (i = 0; i < argc; i++)
+                        sz += strlen(argv[i]) + 1;
+
+                if (!(str = dm_zalloc(sz))) {
+                        err("message string allocation failed");
+                        goto out;
+                }
+
+                for (i = 0; i < argc; i++) {
+                        if (i)
+                                strcat(str, " ");
+                        strcat(str, argv[i]);
+                }
+        }
 
 	i = dm_task_set_message(dmt, str);
 
+        wipememory (str, strlen(str));
 	dm_free(str);
 
 	if (!i)
@@ -5132,7 +5166,7 @@ static struct command _dmsetup_commands[] = {
 	{"reload", "<device> [<table>|<table_file>]", 0, 2, 0, 0, _load},
 	{"wipe_table", "[-f|--force] [--noflush] [--nolockfs] <device>", 1, -1, 1, 0, _error_device},
 	{"rename", "<device> [--setuuid] <new_name_or_uuid>", 1, 2, 0, 0, _rename},
-	{"message", "<device> <sector> <message>", 2, -1, 0, 0, _message},
+	{"message", "<device> <sector> [<message>]", 2, -1, 0, 0, _message},
 	{"ls", "[--target <target_type>] [--exec <command>] [-o <options>] [--tree]", 0, 0, 0, 0, _ls},
 	{"info", "[<device>]", 0, -1, 1, 0, _info},
 	{"deps", "[-o <options>] [<device>]", 0, -1, 1, 0, _deps},
-- 
2.1.4


[-- Attachment #3: Type: text/plain, Size: 0 bytes --]



^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] dmsetup: improve message command
  2016-02-26 11:42 [PATCH] dmsetup: improve message command Werner Koch
@ 2016-03-18 11:06 ` Werner Koch
  2016-03-18 11:52   ` Zdenek Kabelac
  0 siblings, 1 reply; 5+ messages in thread
From: Werner Koch @ 2016-03-18 11:06 UTC (permalink / raw)
  To: dm-devel

[-- Attachment #1: Type: text/plain, Size: 417 bytes --]

On Fri, 26 Feb 2016 12:42, wk@gnupg.org said:

> I am playing with a new crypto container format and propose to enhance
> "dmsetup message" to accept the actual message from stdin instead of
> taking it only from the command line.  This is useful to set a key and

Is there anything I can do to help you evaluate the patch?


Salam-Shalom,

   Werner


-- 
Die Gedanken sind frei.  Ausnahmen regelt ein Bundesgesetz.

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-dmsetup-command-message-may-now-read-the-message-fro.patch --]
[-- Type: text/x-diff, Size: 4737 bytes --]

From ae2b5739007b0829c3a142d0d5e782b3b7fe3028 Mon Sep 17 00:00:00 2001
From: Werner Koch <wk@gnupg.org>
Date: Fri, 19 Feb 2016 21:47:45 +0100
Subject: [PATCH] dmsetup: command message may now read the message from stdin.

When "dmsetup messsage" is used to set an encryption key it is better
to read that from stdin so that the key does not show up in ps or the
shell history.  Thus instead of an error message when the third arg is
missing, it is now taken from stdin.  stdin is also switched to
unbuffered mode so that sensitive data should not end up in stdio
buffers.  A new wipememory macro (taken from GnuPG) is used to
securely erase the message from memory.

Signed-off-by: Werner Koch <wk@gnupg.org>
---
 man/dmsetup.8.in |  5 +++--
 tools/dmsetup.c  | 68 ++++++++++++++++++++++++++++++++++++++++++--------------
 2 files changed, 54 insertions(+), 19 deletions(-)

diff --git a/man/dmsetup.8.in b/man/dmsetup.8.in
index f92dbe5..c9c886a 100644
--- a/man/dmsetup.8.in
+++ b/man/dmsetup.8.in
@@ -127,7 +127,7 @@ dmsetup \(em low level logical volume management
 .  BR message
 .  IR device_name
 .  IR sector
-.  IR message
+.  RI [ message ]
 ..
 .CMD_MESSAGE
 .
@@ -714,7 +714,8 @@ reactivating it with proper mangling mode used (see also \fB\-\-manglename\fP).
 .HP
 .CMD_MESSAGE
 .br
-Send message to target. If sector not needed use 0.
+Send message to target. If sector not needed use 0.  If the message
+argument is not given, the first line read from stdin is used.
 .
 .HP
 .CMD_MKNODES
diff --git a/tools/dmsetup.c b/tools/dmsetup.c
index 4db6004..8e988f0 100644
--- a/tools/dmsetup.c
+++ b/tools/dmsetup.c
@@ -105,6 +105,15 @@ extern char *optarg;
 
 #define err(msg, x...) fprintf(stderr, msg "\n", ##x)
 
+/* To avoid that a compiler optimizes memset calls away, this macro
+ * should be used securely clear memory. */
+#define wipememory(_ptr,_len) do { \
+              volatile char *_vptr=(volatile char *)(_ptr); \
+              size_t _vlen=(_len); \
+              while(_vlen) { *_vptr=0; _vptr++; _vlen--; } \
+                  } while(0)
+
+
 /* program_id used for dmstats-managed statistics regions */
 #define DM_STATS_PROGRAM_ID "dmstats"
 
@@ -1234,25 +1243,50 @@ static int _message(CMD_ARGS)
 	argc--;
 	argv++;
 
-	if (argc <= 0)
-		err("No message supplied.\n");
-
-	for (i = 0; i < argc; i++)
-		sz += strlen(argv[i]) + 1;
-
-	if (!(str = dm_zalloc(sz))) {
-		err("message string allocation failed");
-		goto out;
-	}
-
-	for (i = 0; i < argc; i++) {
-		if (i)
-			strcat(str, " ");
-		strcat(str, argv[i]);
-	}
+	if (argc <= 0) {
+		/* Read messsage from stdin (one line).  */
+                size_t len = LINE_SIZE;
+
+                /* Try avoiding storing potential sensitive data in a
+                 * stdio buffer.  */
+                if (setvbuf (stdin, NULL, _IONBF, BUFSIZ)) {
+                        err("Failed to switch stdin to unbuffered mode.");
+                        goto out;
+                }
+
+                if (!(str = dm_malloc(len))) {
+                        err("Failed to malloc line buffer.");
+                        goto out;
+                }
+
+                if (!fgets(str, (int) len, stdin)) {
+                        err("Error reading line from stdin.");
+                        dm_free(str);
+                        goto out;
+                }
+                len = strlen (str);
+                if (len && str[len-1]=='\n')
+                        str[--len] = 0;
+
+        } else {
+                for (i = 0; i < argc; i++)
+                        sz += strlen(argv[i]) + 1;
+
+                if (!(str = dm_zalloc(sz))) {
+                        err("message string allocation failed");
+                        goto out;
+                }
+
+                for (i = 0; i < argc; i++) {
+                        if (i)
+                                strcat(str, " ");
+                        strcat(str, argv[i]);
+                }
+        }
 
 	i = dm_task_set_message(dmt, str);
 
+        wipememory (str, strlen(str));
 	dm_free(str);
 
 	if (!i)
@@ -5132,7 +5166,7 @@ static struct command _dmsetup_commands[] = {
 	{"reload", "<device> [<table>|<table_file>]", 0, 2, 0, 0, _load},
 	{"wipe_table", "[-f|--force] [--noflush] [--nolockfs] <device>", 1, -1, 1, 0, _error_device},
 	{"rename", "<device> [--setuuid] <new_name_or_uuid>", 1, 2, 0, 0, _rename},
-	{"message", "<device> <sector> <message>", 2, -1, 0, 0, _message},
+	{"message", "<device> <sector> [<message>]", 2, -1, 0, 0, _message},
 	{"ls", "[--target <target_type>] [--exec <command>] [-o <options>] [--tree]", 0, 0, 0, 0, _ls},
 	{"info", "[<device>]", 0, -1, 1, 0, _info},
 	{"deps", "[-o <options>] [<device>]", 0, -1, 1, 0, _deps},
-- 
2.1.4


[-- Attachment #3: Type: text/plain, Size: 0 bytes --]



^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] dmsetup: improve message command
  2016-03-18 11:06 ` Werner Koch
@ 2016-03-18 11:52   ` Zdenek Kabelac
  2016-03-21 10:55     ` Werner Koch
  0 siblings, 1 reply; 5+ messages in thread
From: Zdenek Kabelac @ 2016-03-18 11:52 UTC (permalink / raw)
  To: Werner Koch, dm-devel

Dne 18.3.2016 v 12:06 Werner Koch napsal(a):
> On Fri, 26 Feb 2016 12:42, wk@gnupg.org said:
>
>> I am playing with a new crypto container format and propose to enhance
>> "dmsetup message" to accept the actual message from stdin instead of
>> taking it only from the command line.  This is useful to set a key and
>
> Is there anything I can do to help you evaluate the patch?
>


Hi

It looked usable - thought could you trim down the zeroing of
dm-malloced area (wipememory)  macro.

It's useless for heap allocation.

Unless you show example and compiler which would optimize 'library' call away.
a) such compiler would be horrible broken (since I could always LD_PRELOAD
my free() implementation),
b) we would need to do same for dm_task_struct - since your 'dmsetup mem
is duplicated for dm_task.

Regards

Zdenek

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] dmsetup: improve message command
  2016-03-18 11:52   ` Zdenek Kabelac
@ 2016-03-21 10:55     ` Werner Koch
  2016-03-21 11:20       ` Zdenek Kabelac
  0 siblings, 1 reply; 5+ messages in thread
From: Werner Koch @ 2016-03-21 10:55 UTC (permalink / raw)
  To: Zdenek Kabelac; +Cc: dm-devel

On Fri, 18 Mar 2016 12:52, zkabelac@redhat.com said:

> It looked usable - thought could you trim down the zeroing of
> dm-malloced area (wipememory)  macro.

Actually the patch zeroes the given string (from command line or stdin).
That is in general pretty short and given that this is a command line
tool there won't be any noticable speed penality.

> It's useless for heap allocation.

Sorry, I have to dissent: If dmsetup is swapped out the key would end up
in the swap (which is still not encrypted by default on Linux).  free()
does not zero out the memory and thus another malloc may reveal the key.
Thus it is important to zeroise all sensitive data before a free.

> Unless you show example and compiler which would optimize 'library' call away.
> a) such compiler would be horrible broken (since I could always LD_PRELOAD
> my free() implementation),

It is not about removing a library call but about optimizing compilers
which may remove a plain memset if they can deduce that the memory is
not used after that memset call.  Can you exclude that it will never
happen that a somehow attributed free() will be detected by a future
gcc/clang version to elimination - what they call - dead code?

The current discussion is to provide a memset_s function which other
platforms already have, for example see:

  http://www.openwall.com/lists/musl/2015/09/09/5

The wipememory macro we use in GnuPG is currently the most portable
solution.  There are way faster implementations, for example what we use
in Libgcrypt, but that is overkill and frankly for Linux we should wait
for a memset_s.

> b) we would need to do same for dm_task_struct - since your 'dmsetup mem
> is duplicated for dm_task.

Right.  However a full audit of sensitive code paths in dmsetup was out
of my scope.  I merely did what can be expected for new code.


Shalom-Salam,

   Werner

-- 
Die Gedanken sind frei.  Ausnahmen regelt ein Bundesgesetz.

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] dmsetup: improve message command
  2016-03-21 10:55     ` Werner Koch
@ 2016-03-21 11:20       ` Zdenek Kabelac
  0 siblings, 0 replies; 5+ messages in thread
From: Zdenek Kabelac @ 2016-03-21 11:20 UTC (permalink / raw)
  To: Werner Koch; +Cc: dm-devel

Dne 21.3.2016 v 11:55 Werner Koch napsal(a):
> On Fri, 18 Mar 2016 12:52, zkabelac@redhat.com said:
>
>> It looked usable - thought could you trim down the zeroing of
>> dm-malloced area (wipememory)  macro.
>
> Actually the patch zeroes the given string (from command line or stdin).
> That is in general pretty short and given that this is a command line
> tool there won't be any noticable speed penality.
>
>> It's useless for heap allocation.
>
> Sorry, I have to dissent: If dmsetup is swapped out the key would end up
> in the swap (which is still not encrypted by default on Linux).  free()
> does not zero out the memory and thus another malloc may reveal the key.
> Thus it is important to zeroise all sensitive data before a free.
>
>> Unless you show example and compiler which would optimize 'library' call away.
>> a) such compiler would be horrible broken (since I could always LD_PRELOAD
>> my free() implementation),
>
> It is not about removing a library call but about optimizing compilers
> which may remove a plain memset if they can deduce that the memory is
> not used after that memset call.  Can you exclude that it will never
> happen that a somehow attributed free() will be detected by a future
> gcc/clang version to elimination - what they call - dead code?
>
> The current discussion is to provide a memset_s function which other
> platforms already have, for example see:
>
>    http://www.openwall.com/lists/musl/2015/09/09/5
>
> The wipememory macro we use in GnuPG is currently the most portable
> solution.  There are way faster implementations, for example what we use
> in Libgcrypt, but that is overkill and frankly for Linux we should wait
> for a memset_s.
>
>> b) we would need to do same for dm_task_struct - since your 'dmsetup mem
>> is duplicated for dm_task.
>
> Right.  However a full audit of sensitive code paths in dmsetup was out
> of my scope.  I merely did what can be expected for new code.

I've probably not been clear enough.
As we normally 'clear' i.e. password with memset().

It's about extra zeroing with wipememory() macro.

I'm still convinced  compiler CANNOT 'drop'  memset()  before calling 'free()' 
  it CANNOT optimize this away for heap allocation (it can do it for on stack 
buffer).

It's purely about consistency - we can't do things randomly across code base.
It's either  a)  or  b)  everywhere (dmsetup, libdm,....)

So please either use plain memset(0)in your patch (like we user everywhere 
else) or prove us we need to use weird macros for clearing heap memory as it 
seems to be serious issue.

Regards

Zdenek

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2016-03-21 11:20 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-02-26 11:42 [PATCH] dmsetup: improve message command Werner Koch
2016-03-18 11:06 ` Werner Koch
2016-03-18 11:52   ` Zdenek Kabelac
2016-03-21 10:55     ` Werner Koch
2016-03-21 11:20       ` Zdenek Kabelac

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.