1 /********************************************************************************/
4 /* IBM Thomas J. Watson Research Center */
6 /* (c) Copyright IBM Corporation 2014-2015. */
8 /* All rights reserved. */
10 /* Redistribution and use in source and binary forms, with or without */
11 /* modification, are permitted provided that the following conditions are */
14 /* Redistributions of source code must retain the above copyright notice, */
15 /* this list of conditions and the following disclaimer. */
17 /* Redistributions in binary form must reproduce the above copyright */
18 /* notice, this list of conditions and the following disclaimer in the */
19 /* documentation and/or other materials provided with the distribution. */
21 /* Neither the names of the IBM Corporation nor the names of its */
22 /* contributors may be used to endorse or promote products derived from */
23 /* this software without specific prior written permission. */
25 /* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS */
26 /* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT */
27 /* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR */
28 /* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT */
29 /* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, */
30 /* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
31 /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, */
32 /* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY */
33 /* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT */
34 /* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE */
35 /* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
36 /********************************************************************************/
40 * Eric Richter, erichte@us.ibm.com
41 * Stefan Berger, stefanb@us.ibm.com
42 * David Safford, safford@us.ibm.com
54 #include <arpa/inet.h>
57 #include <fuse/cuse_lowlevel.h>
61 #include <libtpms/tpm_library.h>
62 #include <libtpms/tpm_tis.h>
63 #include <libtpms/tpm_error.h>
64 #include <libtpms/tpm_memory.h>
72 #include "tpm_ioctl.h"
73 #include "swtpm_nvfile.h"
77 #include "threadpool.h"
79 /* maximum size of request buffer */
80 #define TPM_REQ_MAX 4096
82 /* buffer containing the TPM request */
83 static unsigned char *ptm_request
;
85 /* buffer containing the TPM response */
86 static unsigned char *ptm_response
;
88 /* the sizes of the data in the buffers */
89 static uint32_t ptm_req_len
, ptm_res_len
, ptm_res_tot
;
91 /* locality applied to TPM commands */
92 static TPM_MODIFIER_INDICATOR locality
;
94 /* whether the TPM is running (TPM_Init was received) */
95 static bool tpm_running
;
97 /* flags on how to handle locality */
98 static uint32_t locality_flags
;
100 #if GLIB_MAJOR_VERSION >= 2
101 # if GLIB_MINOR_VERSION >= 32
103 GMutex file_ops_lock
;
104 # define FILE_OPS_LOCK &file_ops_lock
108 GMutex
*file_ops_lock
;
109 # define FILE_OPS_LOCK file_ops_lock
114 #error Unsupport glib version
128 /* single message to send to the worker thread */
129 static struct thread_message msg
;
135 TPM_BOOL is_encrypted
;
138 typedef struct stateblob_desc
{
141 TPM_BOOL is_encrypted
;
143 uint32_t data_length
;
146 typedef enum tx_state_type
{
147 TX_STATE_RW_COMMAND
= 1,
148 TX_STATE_SET_STATE_BLOB
= 2,
149 TX_STATE_GET_STATE_BLOB
= 3,
152 typedef struct transfer_state
{
154 /* while in TX_STATE_GET/SET_STATEBLOB */
156 TPM_BOOL blob_is_encrypted
;
157 /* while in TX_STATE_GET */
161 typedef struct TPM_Response_Header
{
165 } __attribute__ ((packed
)) TPM_Response_Header
;
167 /*********************************** data *************************************/
169 static const char *usage
=
170 "usage: %s %s [options]\n"
172 "The following options are supported:\n"
174 "-n NAME|--name=NAME : device name (mandatory)\n"
175 "-M MAJ|--maj=MAJ : device major number\n"
176 "-m MIN|--min=MIN : device minor number\n"
177 "--key file=<path>[,mode=aes-cbc][,format=hex|binary][,remove=[true|false]]\n"
178 " : use an AES key for the encryption of the TPM's state\n"
179 " files; use the given mode for the block encryption;\n"
180 " the key is to be provided as a hex string or in binary\n"
181 " format; the keyfile can be automatically removed using\n"
182 " the remove parameter\n"
183 "--key pwdfile=<path>[,mode=aes-cbc][,remove=[true|false]]\n"
184 " : provide a passphrase in a file; the AES key will be\n"
185 " derived from this passphrase\n"
186 "--locality [reject-locality-4][,allow-set-locality]\n"
187 " : reject-locality-4: reject any command in locality 4\n"
188 " allow-set-locality: accept SetLocality command\n"
189 "--migration-key file=<path>[,mode=aes-cbc][,format=hex|binary][,remove=[true|false]]\n"
190 " : use an AES key for the encryption of the TPM's state\n"
191 " when it is retrieved from the TPM via ioctls;\n"
192 " Setting this key ensures that the TPM's state will always\n"
193 " be encrypted when migrated\n"
194 "--migration-key pwdfile=<path>[,mode=aes-cbc][,remove=[true|false]]\n"
195 " : provide a passphrase in a file; the AES key will be\n"
196 " derived from this passphrase\n"
197 "--log file=<path>|fd=<filedescriptor>[,level=n][,prefix=<prefix>][,truncate]\n"
198 " : write the TPM's log into the given file rather than\n"
199 " to the console; provide '-' for path to avoid logging\n"
200 " log level 5 and higher will enable libtpms logging;\n"
201 " all logged output will be prefixed with prefix;\n"
202 " the log file can be reset (truncate)\n"
203 "--pid file=<path>|fd=<filedescriptor>\n"
204 " : write the process ID into the given file\n"
205 "--tpmstate dir=<dir>[,mode=0...]\n"
206 " : set the directory where the TPM's state will be written\n"
207 " into; the TPM_PATH environment variable can be used\n"
209 " mode allows to set the file mode bits of the state\n"
210 " files; the default mode is 0640;\n"
211 "-r|--runas <user> : after creating the CUSE device, change to the given\n"
214 "-h|--help : display this help screen and terminate\n"
217 const static unsigned char TPM_ResetEstablishmentBit
[] = {
218 0x00, 0xC1, /* TPM Request */
219 0x00, 0x00, 0x00, 0x0A, /* length (10) */
220 0x40, 0x00, 0x00, 0x0B /* TPM_ORD_ResetEstablishmentBit */
224 ptm_io_getlocality(TPM_MODIFIER_INDICATOR
*loc
, uint32_t tpmnum
)
230 static struct libtpms_callbacks cbs
= {
231 .sizeOfStruct
= sizeof(struct libtpms_callbacks
),
232 .tpm_nvram_init
= SWTPM_NVRAM_Init
,
233 .tpm_nvram_loaddata
= SWTPM_NVRAM_LoadData
,
234 .tpm_nvram_storedata
= SWTPM_NVRAM_StoreData
,
235 .tpm_nvram_deletename
= SWTPM_NVRAM_DeleteName
,
236 .tpm_io_getlocality
= ptm_io_getlocality
,
239 /* the current state the transfer interface is in */
240 static transfer_state tx_state
;
242 /************************* cached stateblob *********************************/
244 static stateblob_desc cached_stateblob
;
247 * cached_stateblob_is_loaded: is the stateblob with the given properties
248 * the one in the cache?
250 static bool cached_stateblob_is_loaded(uint32_t blobtype
,
253 return (cached_stateblob
.data
!= NULL
) &&
254 (cached_stateblob
.blobtype
== blobtype
) &&
255 (cached_stateblob
.decrypt
== decrypt
);
259 * cached_stateblob_free: Free any previously loaded state blob
261 static void cached_stateblob_free(void)
263 free(cached_stateblob
.data
);
264 cached_stateblob
.data
= NULL
;
265 cached_stateblob
.data_length
= 0;
269 * cached_stateblob_get_bloblength: get the total length of the cached blob
271 static uint32_t cached_stateblob_get_bloblength(void)
273 return cached_stateblob
.data_length
;
277 * cached_statblob_get: get stateblob data without copying them
279 * @offset: at which offset to get the data
280 * @bufptr: pointer to a buffer pointer used to return buffer start
281 * @length: pointer used to return number of available bytes in returned buffer
283 static int cached_stateblob_get(uint32_t offset
,
284 unsigned char **bufptr
, size_t *length
)
286 if (cached_stateblob
.data
== NULL
||
287 offset
> cached_stateblob
.data_length
)
290 *bufptr
= &cached_stateblob
.data
[offset
];
291 *length
= cached_stateblob
.data_length
- offset
;
297 * cached_stateblob_load: load a state blob into the cache
299 * blobtype: the type of blob
300 * decrypt: whether the blob is to be decrypted
302 static TPM_RESULT
cached_stateblob_load(uint32_t blobtype
, TPM_BOOL decrypt
)
305 const char *blobname
= tpmlib_get_blobname(blobtype
);
306 uint32_t tpm_number
= 0;
309 return TPM_BAD_PARAMETER
;
311 cached_stateblob_free();
313 if (blobtype
== PTM_BLOB_TYPE_VOLATILE
)
314 res
= SWTPM_NVRAM_Store_Volatile();
317 res
= SWTPM_NVRAM_GetStateBlob(&cached_stateblob
.data
,
318 &cached_stateblob
.data_length
,
319 tpm_number
, blobname
, decrypt
,
320 &cached_stateblob
.is_encrypted
);
322 /* make sure the volatile state file is gone */
323 if (blobtype
== PTM_BLOB_TYPE_VOLATILE
)
324 SWTPM_NVRAM_DeleteName(tpm_number
, blobname
, FALSE
);
327 cached_stateblob
.blobtype
= blobtype
;
328 cached_stateblob
.decrypt
= decrypt
;
335 * cached_state_blob_copy: copy the cached state blob to a destination buffer
337 * dest: destination buffer
338 * destlen: size of the buffer
339 * srcoffset: offset to copy from
340 * copied: variable to return the number of copied bytes
341 * is_encrypted: variable to return whether the blob is encrypted
343 static int cached_stateblob_copy(void *dest
, size_t destlen
,
344 uint32_t srcoffset
, uint32_t *copied
,
345 TPM_BOOL
*is_encrypted
)
351 if (cached_stateblob
.data
!= NULL
&& cached_stateblob
.data_length
> 0) {
353 if (srcoffset
< cached_stateblob
.data_length
) {
354 *copied
= min(cached_stateblob
.data_length
- srcoffset
, destlen
);
356 memcpy(dest
, &cached_stateblob
.data
[srcoffset
], *copied
);
358 *is_encrypted
= cached_stateblob
.is_encrypted
;
367 /************************* worker thread ************************************/
370 * worker_thread: the worker thread
372 static void worker_thread(gpointer data
, gpointer user_data
)
374 struct thread_message
*msg
= (struct thread_message
*)data
;
377 case MESSAGE_TPM_CMD
:
378 TPMLIB_Process(&ptm_response
, &ptm_res_len
, &ptm_res_tot
,
379 ptm_request
, ptm_req_len
);
385 /* results are ready */
386 worker_thread_mark_done();
389 /***************************** utility functions ****************************/
391 /* _TPM_IO_TpmEstablished_Reset
393 * Reset the TPM Established bit by creating a TPM_ResetEstablishmentBit
394 * command and sending it to the TPM; we temporarily switch the locality
395 * to the one provded to this call. We wait until the TPM has processed
398 static TPM_RESULT
_TPM_IO_TpmEstablished_Reset(fuse_req_t req
,
399 TPM_MODIFIER_INDICATOR locty
)
401 TPM_RESULT res
= TPM_FAIL
;
402 TPM_Response_Header
*tpmrh
;
403 TPM_MODIFIER_INDICATOR orig_locality
= locality
;
407 ptm_req_len
= sizeof(TPM_ResetEstablishmentBit
);
408 memcpy(ptm_request
, TPM_ResetEstablishmentBit
, ptm_req_len
);
410 msg
.type
= MESSAGE_TPM_CMD
;
412 worker_thread_mark_busy();
414 g_thread_pool_push(pool
, &msg
, NULL
);
416 worker_thread_wait_done();
418 if (ptm_res_len
>= sizeof(TPM_Response_Header
)) {
419 tpmrh
= (TPM_Response_Header
*)ptm_response
;
420 res
= ntohl(tpmrh
->returnCode
);
423 locality
= orig_locality
;
429 * tpm_start: Start the TPM
431 * Check whether the TPM's state directory exists and if it does
432 * not exists, try to creat it. Start the thread pool, initilize
433 * libtpms and allocate a global TPM request buffer.
435 * @flags: libtpms init flags
437 static int tpm_start(uint32_t flags
)
440 const char *tpmdir
= tpmstate_get_dir();
442 dir
= opendir(tpmdir
);
446 if (mkdir(tpmdir
, 0775)) {
447 logprintf(STDERR_FILENO
,
448 "Error: Could not open tpmstate dir %s\n",
454 pool
= g_thread_pool_new(worker_thread
,
460 logprintf(STDERR_FILENO
,
461 "Error: Could not create the thread pool.\n");
466 ptm_request
= malloc(4096);
468 logprintf(STDERR_FILENO
,
469 "Error: Could not allocate memory for request buffer.\n");
473 if (tpmlib_start(flags
) != TPM_SUCCESS
)
476 logprintf(STDOUT_FILENO
,
477 "CUSE TPM successfully initialized.\n");
482 g_thread_pool_free(pool
, TRUE
, TRUE
);
489 * ptm_write_fatal_error_response: Write fatal error response
491 * Write a fatal error response into the global ptm_response buffer.
493 static void ptm_write_fatal_error_response(void)
495 tpmlib_write_fatal_error_response(&ptm_response
,
500 /************************************ read() support ***************************/
503 * ptm_read_result: Return the TPM response packet
505 * @req: the fuse_req_t
506 * @size: the max. number of bytes to return to the requester
508 static void ptm_read_result(fuse_req_t req
, size_t size
)
513 /* wait until results are ready */
514 worker_thread_wait_done();
519 if (ptm_res_len
> size
) {
526 fuse_reply_buf(req
, (const char *)ptm_response
, len
);
530 * ptm_read_stateblob: get a TPM stateblob via the read() interface
532 * @req: the fuse_req_t
533 * @size: the number of bytes to read
535 * The internal offset into the buffer is advanced by the number
536 * of bytes that were copied. We switch back to command read/write
537 * mode if an error occurred or once all bytes were read.
539 static void ptm_read_stateblob(fuse_req_t req
, size_t size
)
541 unsigned char *bufptr
= NULL
;
545 if (cached_stateblob_get(tx_state
.offset
, &bufptr
, &numbytes
) < 0) {
546 fuse_reply_err(req
, EIO
);
547 tx_state
.state
= TX_STATE_RW_COMMAND
;
549 tocopy
= MIN(size
, numbytes
);
550 tx_state
.offset
+= tocopy
;
552 fuse_reply_buf(req
, (char *)bufptr
, tocopy
);
553 /* last transfer indicated by less bytes available than requested */
554 if (numbytes
< size
) {
555 tx_state
.state
= TX_STATE_RW_COMMAND
;
561 * ptm_read: interface to POSIX read()
564 * @size: number of bytes to read
565 * @off: offset (not used)
566 * @fi: fuse_file_info (not used)
568 * Depending on the current state of the transfer interface (read/write)
569 * return either the results of TPM commands or a data of a TPM state blob.
571 static void ptm_read(fuse_req_t req
, size_t size
, off_t off
,
572 struct fuse_file_info
*fi
)
574 switch (tx_state
.state
) {
575 case TX_STATE_RW_COMMAND
:
576 ptm_read_result(req
, size
);
578 case TX_STATE_SET_STATE_BLOB
:
579 fuse_reply_err(req
, EIO
);
580 tx_state
.state
= TX_STATE_RW_COMMAND
;
582 case TX_STATE_GET_STATE_BLOB
:
583 ptm_read_stateblob(req
, size
);
588 /*************************read/write stateblob support ***********************/
591 * ptm_set_stateblob_append: Append a piece of TPM state blob and transfer to TPM
593 * blobtype: the type of blob
594 * data: the data to append
595 * length: length of the data
596 * is_encrypted: whether the blob is encrypted
597 * is_last: whether this is the last part of the TPM state blob; if it is, the TPM
598 * state blob will then be transferred to the TPM
601 ptm_set_stateblob_append(uint32_t blobtype
,
602 const unsigned char *data
, uint32_t length
,
603 bool is_encrypted
, bool is_last
)
606 static struct stateblob stateblob
;
609 if (stateblob
.type
!= blobtype
) {
610 /* new blob; clear old data */
611 free(stateblob
.data
);
612 stateblob
.data
= NULL
;
613 stateblob
.length
= 0;
614 stateblob
.type
= blobtype
;
615 stateblob
.is_encrypted
= is_encrypted
;
618 * on the first call for a new state blob we allow 0 bytes to be written
619 * this allows the user to transfer via write()
626 tmp
= realloc(stateblob
.data
, stateblob
.length
+ length
);
628 logprintf(STDERR_FILENO
,
629 "Could not allocate %u bytes.\n", stateblob
.length
+ length
);
631 free(stateblob
.data
);
632 stateblob
.data
= NULL
;
633 stateblob
.length
= 0;
638 stateblob
.data
= tmp
;
640 memcpy(&stateblob
.data
[stateblob
.length
], data
, length
);
641 stateblob
.length
+= length
;
644 /* full packet -- expecting more data */
648 res
= SWTPM_NVRAM_SetStateBlob(stateblob
.data
,
650 stateblob
.is_encrypted
,
654 free(stateblob
.data
);
655 stateblob
.data
= NULL
;
656 stateblob
.length
= 0;
659 /* transfer of blob is complete */
660 tx_state
.state
= TX_STATE_RW_COMMAND
;
666 * ptm_set_stateblob: set part of a TPM state blob
669 * pss: ptm_setstate provided via ioctl()
672 ptm_set_stateblob(fuse_req_t req
, ptm_setstate
*pss
)
675 TPM_BOOL is_encrypted
=
676 ((pss
->u
.req
.state_flags
& PTM_STATE_FLAG_ENCRYPTED
) != 0);
677 bool is_last
= (sizeof(pss
->u
.req
.data
) != pss
->u
.req
.length
);
679 if (pss
->u
.req
.length
> sizeof(pss
->u
.req
.data
)) {
680 res
= TPM_BAD_PARAMETER
;
684 /* transfer of blob initiated */
685 tx_state
.state
= TX_STATE_SET_STATE_BLOB
;
686 tx_state
.blobtype
= pss
->u
.req
.type
;
687 tx_state
.blob_is_encrypted
= is_encrypted
;
690 res
= ptm_set_stateblob_append(pss
->u
.req
.type
,
697 tx_state
.state
= TX_STATE_RW_COMMAND
;
700 pss
->u
.resp
.tpm_result
= res
;
702 fuse_reply_ioctl(req
, 0, pss
, sizeof(*pss
));
706 * ptm_get_stateblob_part: get part of a state blob
708 * @blobtype: the type of blob to get
709 * @buffer: the buffer this function will write the blob into
710 * @buffer_size: the size of the buffer
711 * @offset: the offset into the state blob
712 * @copied: pointer to int to indicate the number of bytes that were copied
713 * @is_encryped: returns whether the state blob is encrypted
716 ptm_get_stateblob_part(uint32_t blobtype
,
717 unsigned char *buffer
, size_t buffer_size
,
718 uint32_t offset
, uint32_t *copied
,
719 TPM_BOOL decrypt
, TPM_BOOL
*is_encrypted
)
723 if (!cached_stateblob_is_loaded(blobtype
, decrypt
)) {
724 res
= cached_stateblob_load(blobtype
, decrypt
);
728 cached_stateblob_copy(buffer
, buffer_size
,
729 offset
, copied
, is_encrypted
);
736 * ptm_get_stateblob: Get the state blob from the TPM using ioctl()
739 ptm_get_stateblob(fuse_req_t req
, ptm_getstate
*pgs
)
742 uint32_t blobtype
= pgs
->u
.req
.type
;
744 ((pgs
->u
.req
.state_flags
& PTM_STATE_FLAG_DECRYPTED
) != 0);
745 TPM_BOOL is_encrypted
= FALSE
;
747 uint32_t offset
= pgs
->u
.req
.offset
;
750 res
= ptm_get_stateblob_part(blobtype
,
751 pgs
->u
.resp
.data
, sizeof(pgs
->u
.resp
.data
),
752 pgs
->u
.req
.offset
, &copied
,
753 decrypt
, &is_encrypted
);
755 totlength
= cached_stateblob_get_bloblength();
757 pgs
->u
.resp
.state_flags
= 0;
759 pgs
->u
.resp
.state_flags
|= PTM_STATE_FLAG_ENCRYPTED
;
761 pgs
->u
.resp
.length
= copied
;
762 pgs
->u
.resp
.totlength
= totlength
;
763 pgs
->u
.resp
.tpm_result
= res
;
766 if (offset
+ copied
< totlength
) {
767 /* last byte was not copied */
768 tx_state
.state
= TX_STATE_GET_STATE_BLOB
;
769 tx_state
.blobtype
= pgs
->u
.req
.type
;
770 tx_state
.blob_is_encrypted
= is_encrypted
;
771 tx_state
.offset
= copied
;
773 /* last byte was copied */
774 tx_state
.state
= TX_STATE_RW_COMMAND
;
778 tx_state
.state
= TX_STATE_RW_COMMAND
;
781 fuse_reply_ioctl(req
, 0, pgs
, sizeof(pgs
->u
.resp
));
784 /*********************************** write() support *************************/
787 * ptm_write_stateblob: Write the state blob using the write() interface
789 * @req: the fuse_req_t
790 * @buf: the buffer with the data
791 * @size: the number of bytes in the buffer
793 * The data are appended to an existing buffer that was created with the
796 static void ptm_write_stateblob(fuse_req_t req
, const char *buf
, size_t size
)
800 res
= ptm_set_stateblob_append(tx_state
.blobtype
,
801 (unsigned char *)buf
, size
,
802 tx_state
.blob_is_encrypted
,
805 tx_state
.state
= TX_STATE_RW_COMMAND
;
806 fuse_reply_err(req
, EIO
);
808 fuse_reply_write(req
, size
);
813 * ptm_write_cmd: User writing a TPM command
816 * buf: the buffer containing the TPM command
817 * size: the size of the buffer
819 static void ptm_write_cmd(fuse_req_t req
, const char *buf
, size_t size
)
824 /* prevent other threads from writing or doing ioctls */
825 g_mutex_lock(FILE_OPS_LOCK
);
828 /* ensure that we only ever work on one TPM command */
829 if (worker_thread_is_busy()) {
830 fuse_reply_err(req
, EBUSY
);
834 if (ptm_req_len
> TPM_REQ_MAX
)
835 ptm_req_len
= TPM_REQ_MAX
;
837 /* process SetLocality command, if */
838 tpmlib_process(&ptm_response
, &ptm_res_len
, &ptm_res_tot
,
839 (unsigned char *)buf
, ptm_req_len
,
840 locality_flags
, &locality
);
844 if (tpmlib_is_request_cancelable(ptm_request
, ptm_req_len
)) {
845 /* have command processed by thread pool */
846 memcpy(ptm_request
, buf
, ptm_req_len
);
848 msg
.type
= MESSAGE_TPM_CMD
;
850 worker_thread_mark_busy();
852 g_thread_pool_push(pool
, &msg
, NULL
);
854 /* direct processing */
855 TPMLIB_Process(&ptm_response
, &ptm_res_len
, &ptm_res_tot
,
856 (unsigned char *)buf
, ptm_req_len
);
859 /* TPM not initialized; return error */
860 ptm_write_fatal_error_response();
864 fuse_reply_write(req
, ptm_req_len
);
867 g_mutex_unlock(FILE_OPS_LOCK
);
873 * ptm_write: low-level write() interface; calls approriate function depending
874 * on what is being transferred using the write()
876 static void ptm_write(fuse_req_t req
, const char *buf
, size_t size
,
877 off_t off
, struct fuse_file_info
*fi
)
879 switch (tx_state
.state
) {
880 case TX_STATE_RW_COMMAND
:
881 ptm_write_cmd(req
, buf
, size
);
883 case TX_STATE_GET_STATE_BLOB
:
884 fuse_reply_err(req
, EIO
);
885 tx_state
.state
= TX_STATE_RW_COMMAND
;
887 case TX_STATE_SET_STATE_BLOB
:
888 ptm_write_stateblob(req
, buf
, size
);
894 * ptm_open: interface to POSIX open()
896 static void ptm_open(fuse_req_t req
, struct fuse_file_info
*fi
)
898 tx_state
.state
= TX_STATE_RW_COMMAND
;
900 fuse_reply_open(req
, fi
);
904 * ptm_ioctl : ioctl execution
906 * req: the fuse_req_t used to send response with
907 * cmd: the ioctl request code
908 * arg: the pointer the application used for calling the ioctl (3rd param)
910 * flags: some flags provided by fuse
911 * in_buf: the copy of the input buffer
912 * in_bufsz: size of the input buffer; provided by fuse and has size of
914 * out_bufsz: size of the output buffer; provided by fuse and has size of
917 static void ptm_ioctl(fuse_req_t req
, int cmd
, void *arg
,
918 struct fuse_file_info
*fi
, unsigned flags
,
919 const void *in_buf
, size_t in_bufsz
, size_t out_bufsz
)
921 TPM_RESULT res
= TPM_FAIL
;
922 bool exit_prg
= FALSE
;
925 /* some commands have to wait until the worker thread is done */
927 case PTM_GET_CAPABILITY
:
928 case PTM_SET_LOCALITY
:
929 case PTM_CANCEL_TPM_CMD
:
931 case PTM_SET_BUFFERSIZE
:
932 /* no need to wait */
936 case PTM_GET_TPMESTABLISHED
:
937 case PTM_RESET_TPMESTABLISHED
:
941 case PTM_STORE_VOLATILE
:
942 case PTM_GET_STATEBLOB
:
943 case PTM_SET_STATEBLOB
:
945 worker_thread_wait_done();
949 /* prevent other threads from writing or doing ioctls */
950 g_mutex_lock(FILE_OPS_LOCK
);
953 case PTM_GET_CAPABILITY
:
954 if (out_bufsz
!= sizeof(ptm_cap
)) {
955 struct iovec iov
= { arg
, sizeof(uint8_t) };
956 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
959 ptm_caps
= PTM_CAP_INIT
| PTM_CAP_SHUTDOWN
960 | PTM_CAP_GET_TPMESTABLISHED
961 | PTM_CAP_SET_LOCALITY
963 | PTM_CAP_CANCEL_TPM_CMD
964 | PTM_CAP_STORE_VOLATILE
965 | PTM_CAP_RESET_TPMESTABLISHED
966 | PTM_CAP_GET_STATEBLOB
967 | PTM_CAP_SET_STATEBLOB
970 | PTM_CAP_SET_BUFFERSIZE
;
971 fuse_reply_ioctl(req
, 0, &ptm_caps
, sizeof(ptm_caps
));
976 if (in_bufsz
!= sizeof(ptm_init
)) {
977 struct iovec iov
= { arg
, sizeof(uint8_t) };
978 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
980 init_p
= (ptm_init
*)in_buf
;
987 if (tpm_start(init_p
->u
.req
.init_flags
) < 0) {
989 logprintf(STDERR_FILENO
,
990 "Error: Could not initialize the TPM.\n");
995 init_p
->u
.resp
.tpm_result
= res
;
996 fuse_reply_ioctl(req
, 0, init_p
, sizeof(*init_p
));
1001 worker_thread_end();
1006 tpm_running
= false;
1009 ptm_response
= NULL
;
1011 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1016 worker_thread_end();
1022 ptm_response
= NULL
;
1024 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1029 case PTM_GET_TPMESTABLISHED
:
1031 goto error_not_running
;
1033 if (out_bufsz
!= sizeof(ptm_est
)) {
1034 struct iovec iov
= { arg
, sizeof(uint8_t) };
1035 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1038 te
.u
.resp
.tpm_result
= TPM_IO_TpmEstablished_Get(&te
.u
.resp
.bit
);
1039 fuse_reply_ioctl(req
, 0, &te
, sizeof(te
));
1043 case PTM_RESET_TPMESTABLISHED
:
1045 goto error_not_running
;
1047 if (in_bufsz
!= sizeof(ptm_reset_est
)) {
1048 struct iovec iov
= { arg
, sizeof(uint32_t) };
1049 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1051 ptm_reset_est
*re
= (ptm_reset_est
*)in_buf
;
1052 if (re
->u
.req
.loc
> 4) {
1053 res
= TPM_BAD_LOCALITY
;
1055 res
= _TPM_IO_TpmEstablished_Reset(req
, re
->u
.req
.loc
);
1056 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1061 case PTM_SET_LOCALITY
:
1062 if (in_bufsz
!= sizeof(ptm_loc
)) {
1063 struct iovec iov
= { arg
, sizeof(uint32_t) };
1064 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1066 ptm_loc
*l
= (ptm_loc
*)in_buf
;
1067 if (l
->u
.req
.loc
> 4 ||
1068 (l
->u
.req
.loc
== 4 &&
1069 locality_flags
& LOCALITY_FLAG_REJECT_LOCALITY_4
)) {
1070 res
= TPM_BAD_LOCALITY
;
1073 locality
= l
->u
.req
.loc
;
1075 l
->u
.resp
.tpm_result
= res
;
1076 fuse_reply_ioctl(req
, 0, l
, sizeof(*l
));
1080 case PTM_HASH_START
:
1082 goto error_not_running
;
1084 res
= TPM_IO_Hash_Start();
1085 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1090 goto error_not_running
;
1092 if (in_bufsz
!= sizeof(ptm_hdata
)) {
1093 struct iovec iov
= { arg
, sizeof(uint32_t) };
1094 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1096 ptm_hdata
*data
= (ptm_hdata
*)in_buf
;
1097 if (data
->u
.req
.length
<= sizeof(data
->u
.req
.data
)) {
1098 res
= TPM_IO_Hash_Data(data
->u
.req
.data
,
1099 data
->u
.req
.length
);
1103 data
->u
.resp
.tpm_result
= res
;
1104 fuse_reply_ioctl(req
, 0, data
, sizeof(*data
));
1110 goto error_not_running
;
1112 res
= TPM_IO_Hash_End();
1113 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1116 case PTM_CANCEL_TPM_CMD
:
1118 goto error_not_running
;
1120 /* for cancellation to work, the TPM would have to
1121 * execute in another thread that polls on a cancel
1125 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1128 case PTM_STORE_VOLATILE
:
1130 goto error_not_running
;
1132 res
= SWTPM_NVRAM_Store_Volatile();
1133 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1135 cached_stateblob_free();
1138 case PTM_GET_STATEBLOB
:
1140 goto error_not_running
;
1142 if (in_bufsz
!= sizeof(ptm_getstate
)) {
1143 struct iovec iov
= { arg
, sizeof(uint32_t) };
1144 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1146 ptm_get_stateblob(req
, (ptm_getstate
*)in_buf
);
1150 case PTM_SET_STATEBLOB
:
1154 /* tpm state dir must be set */
1157 if (in_bufsz
!= sizeof(ptm_setstate
)) {
1158 struct iovec iov
= { arg
, sizeof(uint32_t) };
1159 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1161 ptm_set_stateblob(req
, (ptm_setstate
*)in_buf
);
1165 case PTM_GET_CONFIG
:
1166 if (out_bufsz
!= sizeof(ptm_getconfig
)) {
1167 struct iovec iov
= { arg
, sizeof(uint32_t) };
1168 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1171 pgs
.u
.resp
.tpm_result
= 0;
1172 pgs
.u
.resp
.flags
= 0;
1173 if (SWTPM_NVRAM_Has_FileKey())
1174 pgs
.u
.resp
.flags
|= PTM_CONFIG_FLAG_FILE_KEY
;
1175 if (SWTPM_NVRAM_Has_MigrationKey())
1176 pgs
.u
.resp
.flags
|= PTM_CONFIG_FLAG_MIGRATION_KEY
;
1177 fuse_reply_ioctl(req
, 0, &pgs
, sizeof(pgs
));
1181 case PTM_SET_BUFFERSIZE
:
1182 if (out_bufsz
!= sizeof(ptm_setbuffersize
)) {
1183 struct iovec iov
= { arg
, sizeof(uint32_t) };
1184 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1186 ptm_setbuffersize
*in_psbs
= (ptm_setbuffersize
*)in_buf
;
1187 ptm_setbuffersize out_psbs
;
1188 uint32_t buffersize
, minsize
, maxsize
;
1190 buffersize
= in_psbs
->u
.req
.buffersize
;
1192 if (buffersize
> 0 && tpm_running
)
1195 buffersize
= TPMLIB_SetBufferSize(buffersize
,
1199 out_psbs
.u
.resp
.tpm_result
= TPM_SUCCESS
;
1200 out_psbs
.u
.resp
.buffersize
= buffersize
;
1201 out_psbs
.u
.resp
.minsize
= minsize
;
1202 out_psbs
.u
.resp
.maxsize
= maxsize
;
1203 fuse_reply_ioctl(req
, 0, &out_psbs
, sizeof(out_psbs
));
1208 if (out_bufsz
!= sizeof(ptm_getinfo
)) {
1209 struct iovec iov
= { arg
, sizeof(uint32_t) };
1210 fuse_reply_ioctl_retry(req
, &iov
, 1, NULL
, 0);
1212 ptm_getinfo
*in_pgi
= (ptm_getinfo
*)in_buf
;
1213 ptm_getinfo out_pgi
;
1215 uint32_t length
, offset
;
1217 info_data
= TPMLIB_GetInfo(in_pgi
->u
.req
.flags
);
1221 offset
= in_pgi
->u
.req
.offset
;
1222 if (offset
>= strlen(info_data
)) {
1224 goto error_bad_input
;
1227 length
= min(strlen(info_data
) + 1 - offset
,
1228 sizeof(out_pgi
.u
.resp
.buffer
));
1230 out_pgi
.u
.resp
.tpm_result
= 0;
1231 out_pgi
.u
.resp
.totlength
= strlen(info_data
) + 1;
1232 out_pgi
.u
.resp
.length
= length
;
1233 /* client has to collect whole string in case buffer is too small */
1234 memcpy(out_pgi
.u
.resp
.buffer
, &info_data
[offset
], length
);
1237 fuse_reply_ioctl(req
, 0, &out_pgi
, sizeof(out_pgi
));
1242 fuse_reply_err(req
, EINVAL
);
1246 g_mutex_unlock(FILE_OPS_LOCK
);
1249 logprintf(STDOUT_FILENO
, "CUSE TPM is shutting down.\n");
1258 res
= TPM_BAD_PARAMETER
;
1259 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1265 res
= TPM_BAD_ORDINAL
;
1266 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1272 fuse_reply_ioctl(req
, 0, &res
, sizeof(res
));
1277 static void ptm_init_done(void *userdata
)
1279 struct cuse_param
*param
= userdata
;
1282 /* at this point the entry in /dev/ is available */
1283 if (pidfile_write(getpid()) < 0) {
1288 ret
= change_process_owner(param
->runas
);
1294 static const struct cuse_lowlevel_ops clops
= {
1299 .init_done
= ptm_init_done
,
1302 #ifndef HAVE_SWTPM_CUSE_MAIN
1303 int main(int argc
, char **argv
)
1305 const char *prgname
= argv
[0];
1306 const char *iface
= "";
1308 int swtpm_cuse_main(int argc
, char **argv
, const char *prgname
, const char *iface
)
1311 int opt
, longindex
= 0;
1312 static struct option longopts
[] = {
1313 {"maj" , required_argument
, 0, 'M'},
1314 {"min" , required_argument
, 0, 'm'},
1315 {"name" , required_argument
, 0, 'n'},
1316 {"runas" , required_argument
, 0, 'r'},
1317 {"log" , required_argument
, 0, 'l'},
1318 {"locality" , required_argument
, 0, 'L'},
1319 {"key" , required_argument
, 0, 'k'},
1320 {"migration-key" , required_argument
, 0, 'K'},
1321 {"pid" , required_argument
, 0, 'p'},
1322 {"tpmstate" , required_argument
, 0, 's'},
1323 {"help" , no_argument
, 0, 'h'},
1324 {"version" , no_argument
, 0, 'v'},
1327 struct cuse_info cinfo
;
1328 struct cuse_param param
;
1329 const char *devname
= NULL
;
1330 char *cinfo_argv
[1];
1332 struct passwd
*passwd
;
1335 char path
[PATH_MAX
];
1337 memset(&cinfo
, 0, sizeof(cinfo
));
1338 memset(¶m
, 0, sizeof(param
));
1340 log_set_prefix("swtpm: ");
1343 opt
= getopt_long(argc
, argv
, "M:m:n:r:hv", longopts
, &longindex
);
1349 case 'M': /* major */
1350 if (sscanf(optarg
, "%u", &num
) != 1) {
1351 logprintf(STDERR_FILENO
, "Could not parse major number\n");
1355 logprintf(STDERR_FILENO
,
1356 "Major number outside valid range [0 - 65535]\n");
1359 cinfo
.dev_major
= num
;
1361 case 'm': /* minor */
1362 if (sscanf(optarg
, "%u", &num
) != 1) {
1363 logprintf(STDERR_FILENO
, "Could not parse major number\n");
1367 logprintf(STDERR_FILENO
,
1368 "Major number outside valid range [0 - 65535]\n");
1371 cinfo
.dev_minor
= num
;
1373 case 'n': /* name */
1374 if (!cinfo
.dev_info_argc
) {
1375 cinfo_argv
[0] = calloc(1, strlen("DEVNAME=") + strlen(optarg
) + 1);
1376 if (!cinfo_argv
[0]) {
1377 logprintf(STDERR_FILENO
, "Out of memory\n");
1382 strcpy(cinfo_argv
[0], "DEVNAME=");
1383 strcat(cinfo_argv
[0], optarg
);
1385 cinfo
.dev_info_argc
= 1;
1386 cinfo
.dev_info_argv
= (const char **)cinfo_argv
;
1389 case 'r': /* runas */
1390 param
.runas
= optarg
;
1393 param
.logging
= optarg
;
1396 param
.keydata
= optarg
;
1398 case 'K': /* migration-key */
1399 param
.migkeydata
= optarg
;
1402 param
.piddata
= optarg
;
1404 case 's': /* tpmstate */
1405 param
.tpmstatedata
= optarg
;
1408 param
.localitydata
= optarg
;
1410 case 'h': /* help */
1411 fprintf(stdout
, usage
, prgname
, iface
);
1413 case 'v': /* version */
1414 fprintf(stdout
, "TPM emulator CUSE interface version %d.%d.%d, "
1415 "Copyright (c) 2014-2015 IBM Corp.\n",
1423 if (optind
< argc
) {
1424 logprintf(STDERR_FILENO
,
1425 "Unknown parameter '%s'\n", argv
[optind
]);
1426 return EXIT_FAILURE
;
1429 if (!cinfo
.dev_info_argv
) {
1430 logprintf(STDERR_FILENO
, "Error: device name missing\n");
1434 if (handle_log_options(param
.logging
) < 0 ||
1435 handle_key_options(param
.keydata
) < 0 ||
1436 handle_migration_key_options(param
.migkeydata
) < 0 ||
1437 handle_pid_options(param
.piddata
) < 0 ||
1438 handle_tpmstate_options(param
.tpmstatedata
) < 0 ||
1439 handle_locality_options(param
.localitydata
, &locality_flags
) < 0)
1443 logprintf(STDERR_FILENO
, "Error: Unable to setuid root. uid = %d, "
1444 "euid = %d, gid = %d\n", getuid(), geteuid(), getgid());
1449 if (!(passwd
= getpwnam(param
.runas
))) {
1450 logprintf(STDERR_FILENO
, "User '%s' does not exist\n",
1456 tpmdir
= tpmstate_get_dir();
1457 if (tpmdir
== NULL
) {
1458 logprintf(STDERR_FILENO
,
1459 "Error: No TPM state directory is defined; "
1460 "TPM_PATH is not set\n");
1464 n
= snprintf(path
, sizeof(path
), "/dev/%s", devname
);
1466 logprintf(STDERR_FILENO
,
1467 "Error: Could not create device file name\n");
1470 if (n
>= (int)sizeof(path
)) {
1471 logprintf(STDERR_FILENO
,
1472 "Error: Buffer too small to create device file name\n");
1476 tpmfd
= open(path
, O_RDWR
);
1479 logprintf(STDERR_FILENO
,
1480 "Error: A device '%s' already exists.\n",
1485 if (tpmlib_register_callbacks(&cbs
) != TPM_SUCCESS
)
1488 worker_thread_init();
1490 #if GLIB_MINOR_VERSION >= 32
1491 g_mutex_init(FILE_OPS_LOCK
);
1493 FILE_OPS_LOCK
= g_mutex_new();
1496 return cuse_lowlevel_main(1, argv
, &cinfo
, &clops
, ¶m
);