diff mbox

[tpmdd-devel] tpm-emulator: add a TPM emulator pass through

Message ID 1483923513.2644.1.camel@HansenPartnership.com
State New
Headers show

Commit Message

James Bottomley Jan. 9, 2017, 12:58 a.m. UTC
I noticed, while playing around with the kernel based resource
manager, that it's very advantageous to have an emulated TPM device to
test now that I'm playing with startup sequences and TPM ownership.

This is an emulator pass through.  It connects an existing emulator
running on the platform (expected to be the MS Simulator available
from https://sourceforge.net/projects/ibmswtpm2/) and adds it as an
in-kernel device, meaning you can exercise the kernel TPM interface
from either inside the kernel or using the device node.

The tpm-emulator simply connects to the command socket of the MS
simulator (on localhost:2321) and proxies TPM commands.  The
destination and port are settable as module parameters meaning that
the TPM emulator doesn't have to be running locally.

Signed-off-by: James Bottomley <James.Bottomley@HansenPartnership.com>
---
 drivers/char/tpm/Kconfig        |   7 ++
 drivers/char/tpm/Makefile       |   1 +
 drivers/char/tpm/tpm-emulator.c | 231 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 239 insertions(+)
 create mode 100644 drivers/char/tpm/tpm-emulator.c

Comments

Jason Gunthorpe Jan. 9, 2017, 3:49 p.m. UTC | #1
On Sun, Jan 08, 2017 at 04:58:33PM -0800, James Bottomley wrote:
> I noticed, while playing around with the kernel based resource
> manager, that it's very advantageous to have an emulated TPM device to
> test now that I'm playing with startup sequences and TPM ownership.
> 
> This is an emulator pass through.  It connects an existing emulator
> running on the platform (expected to be the MS Simulator available
> from https://sourceforge.net/projects/ibmswtpm2/) and adds it as an
> in-kernel device, meaning you can exercise the kernel TPM interface
> from either inside the kernel or using the device node.
> 
> The tpm-emulator simply connects to the command socket of the MS
> simulator (on localhost:2321) and proxies TPM commands.  The
> destination and port are settable as module parameters meaning that
> the TPM emulator doesn't have to be running locally.

What is wrong with using drivers/char/tpm/tpm_vtpm_proxy.c and doing
the socket connection in userspace?

Jason

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most 
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
James Bottomley Jan. 9, 2017, 4:23 p.m. UTC | #2
On Mon, 2017-01-09 at 08:49 -0700, Jason Gunthorpe wrote:
> On Sun, Jan 08, 2017 at 04:58:33PM -0800, James Bottomley wrote:
> > I noticed, while playing around with the kernel based resource
> > manager, that it's very advantageous to have an emulated TPM device
> > to
> > test now that I'm playing with startup sequences and TPM ownership.
> > 
> > This is an emulator pass through.  It connects an existing emulator
> > running on the platform (expected to be the MS Simulator available
> > from https://sourceforge.net/projects/ibmswtpm2/) and adds it as an
> > in-kernel device, meaning you can exercise the kernel TPM interface
> > from either inside the kernel or using the device node.
> > 
> > The tpm-emulator simply connects to the command socket of the MS
> > simulator (on localhost:2321) and proxies TPM commands.  The
> > destination and port are settable as module parameters meaning that
> > the TPM emulator doesn't have to be running locally.
> 
> What is wrong with using drivers/char/tpm/tpm_vtpm_proxy.c and doing
> the socket connection in userspace?

Simplicity, mostly.  It's a tiny driver to proxy the network protocol
directly, meaning it's much easier to set up.  Plus if you're running
smoke tests in a VM you can actually run the emulator in the host
without any additional code in the guest.

James


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most 
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
Jason Gunthorpe Jan. 9, 2017, 4:54 p.m. UTC | #3
On Mon, Jan 09, 2017 at 08:23:02AM -0800, James Bottomley wrote:
> On Mon, 2017-01-09 at 08:49 -0700, Jason Gunthorpe wrote:
> > On Sun, Jan 08, 2017 at 04:58:33PM -0800, James Bottomley wrote:
> > > I noticed, while playing around with the kernel based resource
> > > manager, that it's very advantageous to have an emulated TPM device
> > > to
> > > test now that I'm playing with startup sequences and TPM ownership.
> > > 
> > > This is an emulator pass through.  It connects an existing emulator
> > > running on the platform (expected to be the MS Simulator available
> > > from https://sourceforge.net/projects/ibmswtpm2/) and adds it as an
> > > in-kernel device, meaning you can exercise the kernel TPM interface
> > > from either inside the kernel or using the device node.
> > > 
> > > The tpm-emulator simply connects to the command socket of the MS
> > > simulator (on localhost:2321) and proxies TPM commands.  The
> > > destination and port are settable as module parameters meaning that
> > > the TPM emulator doesn't have to be running locally.
> > 
> > What is wrong with using drivers/char/tpm/tpm_vtpm_proxy.c and doing
> > the socket connection in userspace?
> 
> Simplicity, mostly.  It's a tiny driver to proxy the network protocol
> directly, meaning it's much easier to set up.

Not sure I see it, surely running a program in userspace is simpler
than patching the kernel?

> Plus if you're running smoke tests in a VM you can actually run the
> emulator in the host without any additional code in the guest.

I haven't tried it, but qemu has TPM passthrough support, so it should
be able to pass /dev/tpm1, created by vtpm through to the guest. AFAIK
this should support all existing guests without a custom kernel or
messing with module options.

Honestly, I'd rather see the emulator community get behind vtpm..

Jason

------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
James Bottomley Jan. 9, 2017, 5:04 p.m. UTC | #4
On Mon, 2017-01-09 at 09:54 -0700, Jason Gunthorpe wrote:
> On Mon, Jan 09, 2017 at 08:23:02AM -0800, James Bottomley wrote:
> > On Mon, 2017-01-09 at 08:49 -0700, Jason Gunthorpe wrote:
> > > On Sun, Jan 08, 2017 at 04:58:33PM -0800, James Bottomley wrote:
> > > > I noticed, while playing around with the kernel based resource
> > > > manager, that it's very advantageous to have an emulated TPM 
> > > > device to test now that I'm playing with startup sequences and 
> > > > TPM ownership.
> > > > 
> > > > This is an emulator pass through.  It connects an existing 
> > > > emulator running on the platform (expected to be the MS 
> > > > Simulator available from 
> > > > https://sourceforge.net/projects/ibmswtpm2/) and adds it
> > > > as an in-kernel device, meaning you can exercise the kernel TPM
> > > > interface from either inside the kernel or using the device
> > > > node.
> > > > 
> > > > The tpm-emulator simply connects to the command socket of the 
> > > > MS simulator (on localhost:2321) and proxies TPM commands.  The
> > > > destination and port are settable as module parameters meaning 
> > > > that the TPM emulator doesn't have to be running locally.
> > > 
> > > What is wrong with using drivers/char/tpm/tpm_vtpm_proxy.c and 
> > > doing the socket connection in userspace?
> > 
> > Simplicity, mostly.  It's a tiny driver to proxy the network 
> > protocol directly, meaning it's much easier to set up.
> 
> Not sure I see it, surely running a program in userspace is simpler
> than patching the kernel?

Heh, is that a serious question to a kernel developer?  If the program
actually existed, sure, but does it?

> > Plus if you're running smoke tests in a VM you can actually run the
> > emulator in the host without any additional code in the guest.
> 
> I haven't tried it, but qemu has TPM passthrough support, so it 
> should be able to pass /dev/tpm1, created by vtpm through to the 
> guest. AFAIK this should support all existing guests without a custom 
> kernel or messing with module options.
> 
> Honestly, I'd rather see the emulator community get behind vtpm..

OK, so work out how to do it and post the instructions and we can see
what's easier for users.  Opinions can always change.  I didn't really
see a need to use an emulated TPM in the kernel until Jarkko's smoke
tests caused a DA lockout on my physical TPM at which point not
impacting all my other TPM based stuff while playing with the kernel
suddenly seemed important.

James


------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
Jason Gunthorpe Jan. 9, 2017, 5:14 p.m. UTC | #5
> > Not sure I see it, surely running a program in userspace is simpler
> > than patching the kernel?
> 
> Heh, is that a serious question to a kernel developer?  If the program
> actually existed, sure, but does it?

Stefan has something to connect vtpm to a TPM2 emulator.

Jason

------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
Stefan Berger Jan. 9, 2017, 6:03 p.m. UTC | #6
On 01/09/2017 12:14 PM, Jason Gunthorpe wrote:
>>> Not sure I see it, surely running a program in userspace is simpler
>>> than patching the kernel?
>> Heh, is that a serious question to a kernel developer?  If the program
>> actually existed, sure, but does it?
> Stefan has something to connect vtpm to a TPM2 emulator.

https://github.com/stefanberger/linux-vtpm-tests

#> ./src/vtpmctrl --help

This is a test tool for the Linux vTPM proxy driver

Usage: ./src/vtpmctrl options

The following options are supported:
--tpm2                 : A TPM 2 is used

--exit-on-user-request : The tool exits upon a request issued by the user.

--spawn program prg-params...
                        : Spawn the given program and pass to it the
                          file descriptor on which to listen for TPM
                          commands. If a parameter '%fd' appears among
                          the prg-params passed to the program, it will
                          be replaced by that file descriptor number.

                          This option must be the last option passed.

--help|-h|-?           : Display this help screen and exit.

Examples:
./src/vtpmctrl --tpm2 \
   --spawn /bin/swtpm chardev --tpm2 --fd %fd --tpmstate dir=/tmp

./src/vtpmctrl \
   --spawn /bin/swtpm chardev --fd %fd --tpmstate dir=/tmp



     Stefan


------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
James Bottomley Jan. 9, 2017, 6:24 p.m. UTC | #7
On Mon, 2017-01-09 at 13:03 -0500, Stefan Berger wrote:
> Examples:
> ./src/vtpmctrl --tpm2 \
>    --spawn /bin/swtpm chardev --tpm2 --fd %fd --tpmstate dir=/tmp

git head for swtpm is giving

Created TPM device /dev/tpm1; vTPM device has fd 4, major/minor = 247/1.
chardev: unrecognized option '--tpm2'

James


------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
Stefan Berger Jan. 9, 2017, 6:41 p.m. UTC | #8
On 01/09/2017 01:24 PM, James Bottomley wrote:
> On Mon, 2017-01-09 at 13:03 -0500, Stefan Berger wrote:
>> Examples:
>> ./src/vtpmctrl --tpm2 \
>>     --spawn /bin/swtpm chardev --tpm2 --fd %fd --tpmstate dir=/tmp
> git head for swtpm is giving
>
> Created TPM device /dev/tpm1; vTPM device has fd 4, major/minor = 247/1.
> chardev: unrecognized option '--tpm2'

You need the tpm2-preview branches of libtpms and swtpm. Why you need 
them is related to the format in which the persistent data are written 
by the TPM 2 implementation. For QEMU it should probably big endian, but 
so far it's not.

Here's a short wiki of libtpms pointing out the issues.

https://github.com/stefanberger/libtpms/wiki

https://github.com/stefanberger/libtpms/tree/tpm2-previewa.rev138
https://github.com/stefanberger/swtpm/tree/tpm2-preview



    Stefan


------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
James Bottomley Jan. 9, 2017, 6:51 p.m. UTC | #9
On Mon, 2017-01-09 at 13:41 -0500, Stefan Berger wrote:
> On 01/09/2017 01:24 PM, James Bottomley wrote:
> > On Mon, 2017-01-09 at 13:03 -0500, Stefan Berger wrote:
> > > Examples:
> > > ./src/vtpmctrl --tpm2 \
> > >     --spawn /bin/swtpm chardev --tpm2 --fd %fd --tpmstate
> > > dir=/tmp
> > git head for swtpm is giving
> > 
> > Created TPM device /dev/tpm1; vTPM device has fd 4, major/minor =
> > 247/1.
> > chardev: unrecognized option '--tpm2'
> 
> You need the tpm2-preview branches of libtpms and swtpm. Why you need
> them is related to the format in which the persistent data are 
> written by the TPM 2 implementation. For QEMU it should probably big 
> endian, but so far it's not.
> 
> Here's a short wiki of libtpms pointing out the issues.
> 
> https://github.com/stefanberger/libtpms/wiki
> 
> https://github.com/stefanberger/libtpms/tree/tpm2-previewa.rev138
> https://github.com/stefanberger/swtpm/tree/tpm2-preview

Basically the synopsis is that it's not yet working well enough to run
the resource manager smoke tests and I need to continue using the
ibmswtpm2 as the emulator or run against the real thing for the time
being.

James


------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
Stefan Berger Jan. 9, 2017, 6:52 p.m. UTC | #10
On 01/09/2017 01:51 PM, James Bottomley wrote:
> On Mon, 2017-01-09 at 13:41 -0500, Stefan Berger wrote:
>> On 01/09/2017 01:24 PM, James Bottomley wrote:
>>> On Mon, 2017-01-09 at 13:03 -0500, Stefan Berger wrote:
>>>> Examples:
>>>> ./src/vtpmctrl --tpm2 \
>>>>      --spawn /bin/swtpm chardev --tpm2 --fd %fd --tpmstate
>>>> dir=/tmp
>>> git head for swtpm is giving
>>>
>>> Created TPM device /dev/tpm1; vTPM device has fd 4, major/minor =
>>> 247/1.
>>> chardev: unrecognized option '--tpm2'
>> You need the tpm2-preview branches of libtpms and swtpm. Why you need
>> them is related to the format in which the persistent data are
>> written by the TPM 2 implementation. For QEMU it should probably big
>> endian, but so far it's not.
>>
>> Here's a short wiki of libtpms pointing out the issues.
>>
>> https://github.com/stefanberger/libtpms/wiki
>>
>> https://github.com/stefanberger/libtpms/tree/tpm2-previewa.rev138
>> https://github.com/stefanberger/swtpm/tree/tpm2-preview
> Basically the synopsis is that it's not yet working well enough to run
> the resource manager smoke tests and I need to continue using the
> ibmswtpm2 as the emulator or run against the real thing for the time
> being.

Have you tried it ?

    Stefan


------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
Jarkko Sakkinen Jan. 9, 2017, 11:10 p.m. UTC | #11
On Sun, Jan 08, 2017 at 04:58:33PM -0800, James Bottomley wrote:
> I noticed, while playing around with the kernel based resource
> manager, that it's very advantageous to have an emulated TPM device to
> test now that I'm playing with startup sequences and TPM ownership.
> 
> This is an emulator pass through.  It connects an existing emulator
> running on the platform (expected to be the MS Simulator available
> from https://sourceforge.net/projects/ibmswtpm2/) and adds it as an
> in-kernel device, meaning you can exercise the kernel TPM interface
> from either inside the kernel or using the device node.
> 
> The tpm-emulator simply connects to the command socket of the MS
> simulator (on localhost:2321) and proxies TPM commands.  The
> destination and port are settable as module parameters meaning that
> the TPM emulator doesn't have to be running locally.
> 
> Signed-off-by: James Bottomley <James.Bottomley@HansenPartnership.com>

I use tpm_vtpm_proxy and [1] to do this.

[1] http://git.infradead.org/users/jjs/tpm2-scripts.git/blob_plain/HEAD:/tpm2-simulator-vtpm

/JArkko


> ---
>  drivers/char/tpm/Kconfig        |   7 ++
>  drivers/char/tpm/Makefile       |   1 +
>  drivers/char/tpm/tpm-emulator.c | 231 ++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 239 insertions(+)
>  create mode 100644 drivers/char/tpm/tpm-emulator.c
> 
> diff --git a/drivers/char/tpm/Kconfig b/drivers/char/tpm/Kconfig
> index 277186d..034faa2 100644
> --- a/drivers/char/tpm/Kconfig
> +++ b/drivers/char/tpm/Kconfig
> @@ -151,6 +151,13 @@ config TCG_VTPM_PROXY
>  	  /dev/vtpmX and a server-side file descriptor on which the vTPM
>  	  can receive commands.
>  
> +config TCG_EMULATOR
> +	tristate "TPM Emulator Interface"
> +	depends on m && TCG_TPM
> +	---help---
> +	  This creates a kernel TPM device which expects to connect to
> +	  the MS simulator socket.  You must have the simulator running
> +	  (powered on and started) before inserting the device.
>  
>  source "drivers/char/tpm/st33zp24/Kconfig"
>  endif # TCG_TPM
> diff --git a/drivers/char/tpm/Makefile b/drivers/char/tpm/Makefile
> index 251d0ed..e2de69d 100644
> --- a/drivers/char/tpm/Makefile
> +++ b/drivers/char/tpm/Makefile
> @@ -20,3 +20,4 @@ obj-$(CONFIG_TCG_TIS_ST33ZP24) += st33zp24/
>  obj-$(CONFIG_TCG_XEN) += xen-tpmfront.o
>  obj-$(CONFIG_TCG_CRB) += tpm_crb.o
>  obj-$(CONFIG_TCG_VTPM_PROXY) += tpm_vtpm_proxy.o
> +obj-$(CONFIG_TCG_EMULATOR) += tpm-emulator.o
> diff --git a/drivers/char/tpm/tpm-emulator.c b/drivers/char/tpm/tpm-emulator.c
> new file mode 100644
> index 0000000..f78008c
> --- /dev/null
> +++ b/drivers/char/tpm/tpm-emulator.c
> @@ -0,0 +1,231 @@
> +/*
> + * Copyright 2017 James.Bottomley@HansenPartnership.com
> + *
> + * GPLv2
> + *
> + * Simple socket based connector to a userspace TPM emulator
> + */
> +
> +#include <linux/kernel.h>
> +#include <linux/net.h>
> +#include <linux/inet.h>
> +#include <linux/in.h>
> +#include <linux/module.h>
> +
> +#include <net/net_namespace.h>
> +
> +#include "tpm.h"
> +
> +/*
> + * Currently we only support the MSSIM TPM connections, so every
> + * command must be prefixed with MSSIM_CMD and we have to send
> + * MSSIM_END before we close the socket
> + */
> +#define MSSIM_CMD	8
> +#define MSSIM_END	20
> +
> +/*
> + * Initial assumptions: by default connect to the microsoft simulator
> + * command port on localhost.  Note: this emulator makes no use of the
> + * platform port, so the emulator must be properly initialised (power
> + * on and startup) before being used by this in-kernel system
> + */
> +static char *server = "127.0.0.1";
> +module_param_named(server, server, charp, 0400);
> +MODULE_PARM_DESC(server, "TPM Emulator server address.");
> +static int port = 2321;
> +module_param_named(port, port, uint, 0400);
> +MODULE_PARM_DESC(port, "TPM Emulator server port.");
> +
> +static struct device tdev;
> +
> +static struct socket *tsock;
> +struct sockaddr_in tin;
> +
> +static int priv_recvmsg(void *buf, size_t len, int flags)
> +{
> +	struct kvec iov = {
> +		.iov_base = buf,
> +		.iov_len = len,
> +	};
> +	struct msghdr msg = {
> +		.msg_flags = (flags ? flags : MSG_WAITALL | MSG_NOSIGNAL)
> +	};
> +	return kernel_recvmsg(tsock, &msg, &iov, 1, len, msg.msg_flags);
> +}
> +
> +static void priv_shutdown(void)
> +{
> +	kernel_sock_shutdown(tsock, SHUT_RDWR);
> +	sock_release(tsock);
> +	tsock = NULL;
> +}
> +
> +static int priv_send(void *buf, size_t len)
> +{
> +	int err;
> +	int sent = 0;
> +
> +	struct kvec iov = {
> +		.iov_base = buf,
> +		.iov_len = len,
> +	};
> +	struct msghdr msg = {
> +		.msg_name = NULL,
> +		.msg_namelen = 0,
> +		.msg_control = NULL,
> +		.msg_controllen = 0,
> +		.msg_flags = MSG_WAITALL | MSG_NOSIGNAL,
> +	};
> +
> +	do {
> +		err = kernel_sendmsg(tsock, &msg, &iov, 1, iov.iov_len);
> +		if (err == -EAGAIN)
> +			continue;
> +		if (err < 0) {
> +			priv_shutdown();
> +			return err;
> +		}
> +		sent += err;
> +		iov.iov_base += err;
> +		iov.iov_len -= err;
> +	} while (sent < len);
> +
> +	return 0;
> +}
> +
> +static int emu_send(struct tpm_chip *chip, u8 *buf, size_t len)
> +{
> +	int ret;
> +	u32 cmd = htonl(MSSIM_CMD), netlen = htonl(len);
> +	u8 locality = 0;
> +
> +	ret = sock_create_kern(&init_net, PF_INET, SOCK_STREAM, IPPROTO_TCP,
> +			       &tsock);
> +	if (ret)
> +		return ret;
> +
> +	ret = kernel_connect(tsock, (struct sockaddr *)&tin, sizeof(tin), 0);
> +	if (ret)
> +		goto out;
> +
> +	ret = priv_send(&cmd, sizeof(cmd));
> +	if (ret)
> +		goto out;
> +	ret = priv_send(&locality, sizeof(locality));
> +	if (ret)
> +		goto out;
> +	ret = priv_send(&netlen, sizeof(netlen));
> +	if (ret)
> +		goto out;
> +
> +	ret = priv_send(buf, len);
> +
> + out:
> +	if (ret < 0)
> +		priv_shutdown();
> +	return ret;
> +
> +}
> +
> +static int emu_recv(struct tpm_chip *chip, u8 *buf, size_t len)
> +{
> +	int ret;
> +	u32 header = htonl(MSSIM_END);
> +	u32 reclen;
> +	u32 ack;
> +
> +	ret = priv_recvmsg(&reclen, sizeof(reclen), 0);
> +	if (ret != sizeof(reclen)) {
> +		dev_err(&tdev, "Socket receive failed: %d\n", ret);
> +		goto out;
> +	}
> +	reclen = ntohl(reclen);
> +	if (len < reclen) {
> +		dev_err(&tdev, "response is too large %d\n", reclen);
> +		ret = -EINVAL;
> +		goto out;
> +	}
> +
> +	ret = priv_recvmsg(buf, reclen, 0);
> +	if (ret > 0)
> +		/* receive the ack packet, should be zero */
> +		priv_recvmsg(&ack, sizeof(ack), 0);
> +
> + out:
> +	priv_send(&header, sizeof(header));
> +	priv_shutdown();
> +
> +	return ret;
> +}
> +
> +static struct tpm_class_ops emulator_ops = {
> +	.flags = TPM_OPS_AUTO_STARTUP,
> +	.send = emu_send,
> +	.recv = emu_recv,
> +};
> +
> +static void emu_dev_release(struct device *dev)
> +{
> +}
> +
> +static int emu_init(void)
> +{
> +	int err;
> +	struct tpm_chip *chip;
> +
> +	tin.sin_family = AF_INET;
> +	tin.sin_addr.s_addr = in_aton(server);
> +	tin.sin_port = htons(port);
> +
> +	device_initialize(&tdev);
> +	/* stop drivers/base/core.c from complaining */
> +	tdev.release = emu_dev_release;
> +	err = dev_set_name(&tdev, "emulated-tpm");
> +	if (err)
> +		goto err_out;
> +	err = device_add(&tdev);
> +	if (err)
> +		goto err_out;
> +
> +	chip = tpmm_chip_alloc(&tdev, &emulator_ops);
> +	if (IS_ERR(chip)) {
> +		err = PTR_ERR(chip);
> +		goto err_del;
> +	}
> +	chip->flags |= TPM_CHIP_FLAG_IRQ;
> +	err = tpm2_probe(chip);
> +	if (err)
> +		goto err_del;
> +
> +	err = tpm_chip_register(chip);
> +
> +	dev_info(&tdev, "%s TPM emulator\n",
> +		 (chip->flags & TPM_CHIP_FLAG_TPM2) ? "2.0" : "1.2");
> +
> +	if (!err)
> +		return 0;
> +
> + err_del:
> +	device_del(&tdev);
> + err_out:
> +
> +	put_device(&tdev);
> +
> +	return err;
> +}
> +
> +static void emu_exit(void)
> +{
> +	struct tpm_chip *chip = dev_get_drvdata(&tdev);
> +
> +	tpm_chip_unregister(chip);
> +	device_del(&tdev);
> +	put_device(&tdev);
> +}
> +
> +module_init(emu_init);
> +module_exit(emu_exit);
> +
> +MODULE_AUTHOR("James Bottomley <James.Bottomley@HansenPartnership.com>");
> +MODULE_LICENSE("GPL v2");
> -- 
> 2.6.6
> 
> 
> 
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most 
> engaging tech sites, SlashDot.org! http://sdm.link/slashdot
> _______________________________________________
> tpmdd-devel mailing list
> tpmdd-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/tpmdd-devel

------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
Kenneth Goldman Jan. 10, 2017, 7:24 p.m. UTC | #12
On 1/9/2017 12:04 PM, James Bottomley wrote:
> I didn't really see a need to use an emulated TPM in the kernel until
> Jarkko's smoke tests caused a DA lockout on my physical TPM at which
> point not impacting all my other TPM based stuff while playing with
> the kernel suddenly seemed important.

FYI, set (or leave empty) lockout auth.  Then you can use 
TPM2_DictionaryAttackLockReset() to reset the DA lockout.

(I still wholly endorse use of the SW TPM for debug. Debugging using a 
HW TPM is difficult.)



------------------------------------------------------------------------------
Developer Access Program for Intel Xeon Phi Processors
Access to Intel Xeon Phi processor-based developer platforms.
With one year of Intel Parallel Studio XE.
Training and support from Colfax.
Order your platform today. http://sdm.link/xeonphi
diff mbox

Patch

diff --git a/drivers/char/tpm/Kconfig b/drivers/char/tpm/Kconfig
index 277186d..034faa2 100644
--- a/drivers/char/tpm/Kconfig
+++ b/drivers/char/tpm/Kconfig
@@ -151,6 +151,13 @@  config TCG_VTPM_PROXY
 	  /dev/vtpmX and a server-side file descriptor on which the vTPM
 	  can receive commands.
 
+config TCG_EMULATOR
+	tristate "TPM Emulator Interface"
+	depends on m && TCG_TPM
+	---help---
+	  This creates a kernel TPM device which expects to connect to
+	  the MS simulator socket.  You must have the simulator running
+	  (powered on and started) before inserting the device.
 
 source "drivers/char/tpm/st33zp24/Kconfig"
 endif # TCG_TPM
diff --git a/drivers/char/tpm/Makefile b/drivers/char/tpm/Makefile
index 251d0ed..e2de69d 100644
--- a/drivers/char/tpm/Makefile
+++ b/drivers/char/tpm/Makefile
@@ -20,3 +20,4 @@  obj-$(CONFIG_TCG_TIS_ST33ZP24) += st33zp24/
 obj-$(CONFIG_TCG_XEN) += xen-tpmfront.o
 obj-$(CONFIG_TCG_CRB) += tpm_crb.o
 obj-$(CONFIG_TCG_VTPM_PROXY) += tpm_vtpm_proxy.o
+obj-$(CONFIG_TCG_EMULATOR) += tpm-emulator.o
diff --git a/drivers/char/tpm/tpm-emulator.c b/drivers/char/tpm/tpm-emulator.c
new file mode 100644
index 0000000..f78008c
--- /dev/null
+++ b/drivers/char/tpm/tpm-emulator.c
@@ -0,0 +1,231 @@ 
+/*
+ * Copyright 2017 James.Bottomley@HansenPartnership.com
+ *
+ * GPLv2
+ *
+ * Simple socket based connector to a userspace TPM emulator
+ */
+
+#include <linux/kernel.h>
+#include <linux/net.h>
+#include <linux/inet.h>
+#include <linux/in.h>
+#include <linux/module.h>
+
+#include <net/net_namespace.h>
+
+#include "tpm.h"
+
+/*
+ * Currently we only support the MSSIM TPM connections, so every
+ * command must be prefixed with MSSIM_CMD and we have to send
+ * MSSIM_END before we close the socket
+ */
+#define MSSIM_CMD	8
+#define MSSIM_END	20
+
+/*
+ * Initial assumptions: by default connect to the microsoft simulator
+ * command port on localhost.  Note: this emulator makes no use of the
+ * platform port, so the emulator must be properly initialised (power
+ * on and startup) before being used by this in-kernel system
+ */
+static char *server = "127.0.0.1";
+module_param_named(server, server, charp, 0400);
+MODULE_PARM_DESC(server, "TPM Emulator server address.");
+static int port = 2321;
+module_param_named(port, port, uint, 0400);
+MODULE_PARM_DESC(port, "TPM Emulator server port.");
+
+static struct device tdev;
+
+static struct socket *tsock;
+struct sockaddr_in tin;
+
+static int priv_recvmsg(void *buf, size_t len, int flags)
+{
+	struct kvec iov = {
+		.iov_base = buf,
+		.iov_len = len,
+	};
+	struct msghdr msg = {
+		.msg_flags = (flags ? flags : MSG_WAITALL | MSG_NOSIGNAL)
+	};
+	return kernel_recvmsg(tsock, &msg, &iov, 1, len, msg.msg_flags);
+}
+
+static void priv_shutdown(void)
+{
+	kernel_sock_shutdown(tsock, SHUT_RDWR);
+	sock_release(tsock);
+	tsock = NULL;
+}
+
+static int priv_send(void *buf, size_t len)
+{
+	int err;
+	int sent = 0;
+
+	struct kvec iov = {
+		.iov_base = buf,
+		.iov_len = len,
+	};
+	struct msghdr msg = {
+		.msg_name = NULL,
+		.msg_namelen = 0,
+		.msg_control = NULL,
+		.msg_controllen = 0,
+		.msg_flags = MSG_WAITALL | MSG_NOSIGNAL,
+	};
+
+	do {
+		err = kernel_sendmsg(tsock, &msg, &iov, 1, iov.iov_len);
+		if (err == -EAGAIN)
+			continue;
+		if (err < 0) {
+			priv_shutdown();
+			return err;
+		}
+		sent += err;
+		iov.iov_base += err;
+		iov.iov_len -= err;
+	} while (sent < len);
+
+	return 0;
+}
+
+static int emu_send(struct tpm_chip *chip, u8 *buf, size_t len)
+{
+	int ret;
+	u32 cmd = htonl(MSSIM_CMD), netlen = htonl(len);
+	u8 locality = 0;
+
+	ret = sock_create_kern(&init_net, PF_INET, SOCK_STREAM, IPPROTO_TCP,
+			       &tsock);
+	if (ret)
+		return ret;
+
+	ret = kernel_connect(tsock, (struct sockaddr *)&tin, sizeof(tin), 0);
+	if (ret)
+		goto out;
+
+	ret = priv_send(&cmd, sizeof(cmd));
+	if (ret)
+		goto out;
+	ret = priv_send(&locality, sizeof(locality));
+	if (ret)
+		goto out;
+	ret = priv_send(&netlen, sizeof(netlen));
+	if (ret)
+		goto out;
+
+	ret = priv_send(buf, len);
+
+ out:
+	if (ret < 0)
+		priv_shutdown();
+	return ret;
+
+}
+
+static int emu_recv(struct tpm_chip *chip, u8 *buf, size_t len)
+{
+	int ret;
+	u32 header = htonl(MSSIM_END);
+	u32 reclen;
+	u32 ack;
+
+	ret = priv_recvmsg(&reclen, sizeof(reclen), 0);
+	if (ret != sizeof(reclen)) {
+		dev_err(&tdev, "Socket receive failed: %d\n", ret);
+		goto out;
+	}
+	reclen = ntohl(reclen);
+	if (len < reclen) {
+		dev_err(&tdev, "response is too large %d\n", reclen);
+		ret = -EINVAL;
+		goto out;
+	}
+
+	ret = priv_recvmsg(buf, reclen, 0);
+	if (ret > 0)
+		/* receive the ack packet, should be zero */
+		priv_recvmsg(&ack, sizeof(ack), 0);
+
+ out:
+	priv_send(&header, sizeof(header));
+	priv_shutdown();
+
+	return ret;
+}
+
+static struct tpm_class_ops emulator_ops = {
+	.flags = TPM_OPS_AUTO_STARTUP,
+	.send = emu_send,
+	.recv = emu_recv,
+};
+
+static void emu_dev_release(struct device *dev)
+{
+}
+
+static int emu_init(void)
+{
+	int err;
+	struct tpm_chip *chip;
+
+	tin.sin_family = AF_INET;
+	tin.sin_addr.s_addr = in_aton(server);
+	tin.sin_port = htons(port);
+
+	device_initialize(&tdev);
+	/* stop drivers/base/core.c from complaining */
+	tdev.release = emu_dev_release;
+	err = dev_set_name(&tdev, "emulated-tpm");
+	if (err)
+		goto err_out;
+	err = device_add(&tdev);
+	if (err)
+		goto err_out;
+
+	chip = tpmm_chip_alloc(&tdev, &emulator_ops);
+	if (IS_ERR(chip)) {
+		err = PTR_ERR(chip);
+		goto err_del;
+	}
+	chip->flags |= TPM_CHIP_FLAG_IRQ;
+	err = tpm2_probe(chip);
+	if (err)
+		goto err_del;
+
+	err = tpm_chip_register(chip);
+
+	dev_info(&tdev, "%s TPM emulator\n",
+		 (chip->flags & TPM_CHIP_FLAG_TPM2) ? "2.0" : "1.2");
+
+	if (!err)
+		return 0;
+
+ err_del:
+	device_del(&tdev);
+ err_out:
+
+	put_device(&tdev);
+
+	return err;
+}
+
+static void emu_exit(void)
+{
+	struct tpm_chip *chip = dev_get_drvdata(&tdev);
+
+	tpm_chip_unregister(chip);
+	device_del(&tdev);
+	put_device(&tdev);
+}
+
+module_init(emu_init);
+module_exit(emu_exit);
+
+MODULE_AUTHOR("James Bottomley <James.Bottomley@HansenPartnership.com>");
+MODULE_LICENSE("GPL v2");