Skip to content

GitLab

Commit c6cb053e authored by Roman Peniaev's avatar Roman Peniaev Committed by Chris Ball
Browse files

mmc-utils: RPMB: add support for 4 rpmb operations 



mmc rpmb write-key <rpmb device> <key file>
  Program authentication key which is 32 bytes length and stored in the specified file.
  Also you can specify '-' instead of key file path and utility will read the key from stdin.
  BEWARE: key can be programmed only once!
  Example:
    $ echo -n AAAABBBBCCCCDDDDEEEEFFFFGGGGHHHH | mmc rpmb write-key /dev/mmcblk0rpmb -

mmc rpmb read-counter <rpmb device>
  Counter value for the <rpmb device> will be read to stdout.

mmc rpmb read-block <rpmb device> <address> <blocks count> <output file> [key file]
  Blocks of 256 bytes will be read from <rpmb device> to output file or stdout if '-'
  is specified instead of regular path. If key is specified - read data will be verified.
  Instead of regular path you can specify '-' and key will be read from stdin.
  Example:
    $ echo -n AAAABBBBCCCCDDDDEEEEFFFFGGGGHHHH | \
        mmc rpmb read-block /dev/mmcblk0rpmb 0x02 2 /tmp/block -
  or read the block without verification
    $ mmc rpmb read-block /dev/mmcblk0rpmb 0x02 2 /tmp/block

mmc rpmb write-block <rpmb device> <address> <256 byte data file> <key file>
  Block of 256 bytes will be written from data file to <rpmb device>.
  Also you can specify '-' instead of key file path or data file and utility will read the
  data from stdin.
  Example:
    $ (awk 'BEGIN {while (c++<256) printf "a"}' | echo -n AAAABBBBCCCCDDDDEEEEFFFFGGGGHHHH) | \
      mmc rpmb write-block /dev/mmcblk0rpmb 0x02 - -
Signed-off-by: default avatarRoman Pen <r.peniaev@gmail.com>
Cc: Ulf Hansson <ulf.hansson@linaro.org>,
Cc: Ben Gardiner <bengardiner@nanometrics.ca>,
Signed-off-by: default avatarChris Ball <chris@printf.net>
parent 35c31fea
Hide whitespace changes
Inline Side-by-side
mmc.c
View file @ c6cb053e
......@@ -110,6 +110,39 @@ static struct Command commands[] = {
"Send Sanitize command to the <device>.\nThis will delete the unmapped memory region of the device.",
NULL
},
{ do_rpmb_write_key, -1,
"rpmb write-key", "<rpmb device> <key file>\n"
"Program authentication key which is 32 bytes length and stored in the specified file.\n"
"Also you can specify '-' instead of key file path and utility will read the key from stdin.\n"
"BEWARE: key can be programmed only once!\n"
"Example:\n"
" $ echo -n AAAABBBBCCCCDDDDEEEEFFFFGGGGHHHH | mmc rpmb write-key /dev/mmcblk0rpmb -",
NULL
},
{ do_rpmb_read_counter, -1,
"rpmb read-counter", "<rpmb device>\n"
"Counter value for the <rpmb device> will be read to stdout.",
NULL
},
{ do_rpmb_read_block, -1,
"rpmb read-block", "<rpmb device> <address> <blocks count> <output file> [key file]\n"
"Blocks of 256 bytes will be read from <rpmb device> to output file or stdout if '-' is specified instead of regular path.\n"
"If key is specified - read data will be verified. Instead of regular path you can specify '-' and key will be read from stdin.\n"
"Example:\n"
" $ echo -n AAAABBBBCCCCDDDDEEEEFFFFGGGGHHHH | mmc rpmb read-block /dev/mmcblk0rpmb 0x02 2 /tmp/block -\n"
"or read two blocks without verification\n"
" $ mmc rpmb read-block /dev/mmcblk0rpmb 0x02 2 /tmp/block",
NULL
},
{ do_rpmb_write_block, -1,
"rpmb write-block", "<rpmb device> <address> <256 byte data file> <key file>\n"
"Block of 256 bytes will be written from data file to <rpmb device>.\n"
"Also you can specify '-' instead of key file path or data file and utility will read the data from stdin.\n"
"Example:\n"
" $ (awk 'BEGIN {while (c++<256) printf \"a\"}' | echo -n AAAABBBBCCCCDDDDEEEEFFFFGGGGHHHH) | \\\n"
" mmc rpmb write-block /dev/mmcblk0rpmb 0x02 - -",
NULL
},
{ 0, 0, 0, 0 }
};
......
mmc.h
View file @ c6cb053e
......@@ -20,6 +20,10 @@
#define CHECK(expr, msg, err_stmt) { if (expr) { fprintf(stderr, msg); err_stmt; } }
#ifndef offsetof
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
#endif
/* From kernel linux/major.h */
#define MMC_BLOCK_MAJOR 179
......@@ -29,6 +33,8 @@
#define MMC_SEND_STATUS 13 /* ac [31:16] RCA R1 */
#define R1_SWITCH_ERROR (1 << 7) /* sx, c */
#define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target to value */
#define MMC_READ_MULTIPLE_BLOCK 18 /* adtc [31:0] data addr R1 */
#define MMC_WRITE_MULTIPLE_BLOCK 25 /* adtc R1 */
/*
* EXT_CSD fields
......
mmc_cmds.c
View file @ c6cb053e
......@@ -26,9 +26,13 @@
#include <libgen.h>
#include <limits.h>
#include <ctype.h>
#include <errno.h>
#include <stdint.h>
#include <assert.h>
#include "mmc.h"
#include "mmc_cmds.h"
#include "3rdparty/hmac_sha/hmac_sha2.h"
int read_extcsd(int fd, __u8 *ext_csd)
{
......@@ -1163,3 +1167,513 @@ int do_sanitize(int nargs, char **argv)
}
#define DO_IO(func, fd, buf, nbyte) \
({ \
ssize_t ret = 0, r; \
do { \
r = func(fd, buf + ret, nbyte - ret); \
if (r < 0 && errno != EINTR) { \
ret = -1; \
break; \
} \
else if (r > 0) \
ret += r; \
} while (r != 0 && (size_t)ret != nbyte); \
\
ret; \
})
enum rpmb_op_type {
MMC_RPMB_WRITE_KEY = 0x01,
MMC_RPMB_READ_CNT = 0x02,
MMC_RPMB_WRITE = 0x03,
MMC_RPMB_READ = 0x04,
/* For internal usage only, do not use it directly */
MMC_RPMB_READ_RESP = 0x05
};
struct rpmb_frame {
u_int8_t stuff[196];
u_int8_t key_mac[32];
u_int8_t data[256];
u_int8_t nonce[16];
u_int32_t write_counter;
u_int16_t addr;
u_int16_t block_count;
u_int16_t result;
u_int16_t req_resp;
};
/* Performs RPMB operation.
*
* @fd: RPMB device on which we should perform ioctl command
* @frame_in: input RPMB frame, should be properly inited
* @frame_out: output (result) RPMB frame. Caller is responsible for checking
* result and req_resp for output frame.
* @out_cnt: count of outer frames. Used only for multiple blocks reading,
* in the other cases -EINVAL will be returned.
*/
static int do_rpmb_op(int fd,
const struct rpmb_frame *frame_in,
struct rpmb_frame *frame_out,
unsigned int out_cnt)
{
int err;
u_int16_t rpmb_type;
struct mmc_ioc_cmd ioc = {
.arg = 0x0,
.blksz = 512,
.blocks = 1,
.write_flag = 1,
.opcode = MMC_WRITE_MULTIPLE_BLOCK,
.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC,
.data_ptr = (uintptr_t)frame_in
};
if (!frame_in || !frame_out || !out_cnt)
return -EINVAL;
rpmb_type = be16toh(frame_in->req_resp);
switch(rpmb_type) {
case MMC_RPMB_WRITE:
case MMC_RPMB_WRITE_KEY:
if (out_cnt != 1) {
err = -EINVAL;
goto out;
}
/* Write request */
ioc.write_flag |= (1<<31);
err = ioctl(fd, MMC_IOC_CMD, &ioc);
if (err < 0) {
err = -errno;
goto out;
}
/* Result request */
memset(frame_out, 0, sizeof(*frame_out));
frame_out->req_resp = htobe16(MMC_RPMB_READ_RESP);
ioc.write_flag = 1;
ioc.data_ptr = (uintptr_t)frame_out;
err = ioctl(fd, MMC_IOC_CMD, &ioc);
if (err < 0) {
err = -errno;
goto out;
}
/* Get response */
ioc.write_flag = 0;
ioc.opcode = MMC_READ_MULTIPLE_BLOCK;
err = ioctl(fd, MMC_IOC_CMD, &ioc);
if (err < 0) {
err = -errno;
goto out;
}
break;
case MMC_RPMB_READ_CNT:
if (out_cnt != 1) {
err = -EINVAL;
goto out;
}
/* fall through */
case MMC_RPMB_READ:
/* Request */
err = ioctl(fd, MMC_IOC_CMD, &ioc);
if (err < 0) {
err = -errno;
goto out;
}
/* Get response */
ioc.write_flag = 0;
ioc.opcode = MMC_READ_MULTIPLE_BLOCK;
ioc.blocks = out_cnt;
ioc.data_ptr = (uintptr_t)frame_out;
err = ioctl(fd, MMC_IOC_CMD, &ioc);
if (err < 0) {
err = -errno;
goto out;
}
break;
default:
err = -EINVAL;
goto out;
}
out:
return err;
}
int do_rpmb_write_key(int nargs, char **argv)
{
int ret, dev_fd, key_fd;
struct rpmb_frame frame_in = {
.req_resp = htobe16(MMC_RPMB_WRITE_KEY)
}, frame_out;
CHECK(nargs != 3, "Usage: mmc rpmb write-key </path/to/mmcblkXrpmb> </path/to/key>\n",
exit(1));
dev_fd = open(argv[1], O_RDWR);
if (dev_fd < 0) {
perror("device open");
exit(1);
}
if (0 == strcmp(argv[2], "-"))
key_fd = STDIN_FILENO;
else {
key_fd = open(argv[2], O_RDONLY);
if (key_fd < 0) {
perror("can't open key file");
exit(1);
}
}
/* Read the auth key */
ret = DO_IO(read, key_fd, frame_in.key_mac, sizeof(frame_in.key_mac));
if (ret < 0) {
perror("read the key");
exit(1);
} else if (ret != sizeof(frame_in.key_mac)) {
printf("Auth key must be %lu bytes length, but we read only %d, exit\n",
(unsigned long)sizeof(frame_in.key_mac),
ret);
exit(1);
}
/* Execute RPMB op */
ret = do_rpmb_op(dev_fd, &frame_in, &frame_out, 1);
if (ret != 0) {
perror("RPMB ioctl failed");
exit(1);
}
/* Check RPMB response */
if (frame_out.result != 0) {
printf("RPMB operation failed, retcode 0x%04x\n",
be16toh(frame_out.result));
exit(1);
}
close(dev_fd);
if (key_fd != STDIN_FILENO)
close(key_fd);
return ret;
}
int rpmb_read_counter(int dev_fd, unsigned int *cnt)
{
int ret;
struct rpmb_frame frame_in = {
.req_resp = htobe16(MMC_RPMB_READ_CNT)
}, frame_out;
/* Execute RPMB op */
ret = do_rpmb_op(dev_fd, &frame_in, &frame_out, 1);
if (ret != 0) {
perror("RPMB ioctl failed");
exit(1);
}
/* Check RPMB response */
if (frame_out.result != 0)
return be16toh(frame_out.result);
*cnt = be32toh(frame_out.write_counter);
return 0;
}
int do_rpmb_read_counter(int nargs, char **argv)
{
int ret, dev_fd;
unsigned int cnt;
CHECK(nargs != 2, "Usage: mmc rpmb read-counter </path/to/mmcblkXrpmb>\n",
exit(1));
dev_fd = open(argv[1], O_RDWR);
if (dev_fd < 0) {
perror("device open");
exit(1);
}
ret = rpmb_read_counter(dev_fd, &cnt);
/* Check RPMB response */
if (ret != 0) {
printf("RPMB operation failed, retcode 0x%04x\n", ret);
exit(1);
}
close(dev_fd);
printf("Counter value: 0x%08x\n", cnt);
return ret;
}
int do_rpmb_read_block(int nargs, char **argv)
{
int i, ret, dev_fd, data_fd, key_fd = -1;
uint16_t addr, blocks_cnt;
unsigned char key[32];
struct rpmb_frame frame_in = {
.req_resp = htobe16(MMC_RPMB_READ),
}, *frame_out_p;
CHECK(nargs != 5 && nargs != 6, "Usage: mmc rpmb read-block </path/to/mmcblkXrpmb> <address> <blocks count> </path/to/output_file> [/path/to/key]\n",
exit(1));
dev_fd = open(argv[1], O_RDWR);
if (dev_fd < 0) {
perror("device open");
exit(1);
}
/* Get block address */
errno = 0;
addr = strtol(argv[2], NULL, 0);
if (errno) {
perror("incorrect address");
exit(1);
}
frame_in.addr = htobe16(addr);
/* Get blocks count */
errno = 0;
blocks_cnt = strtol(argv[3], NULL, 0);
if (errno) {
perror("incorrect blocks count");
exit(1);
}
if (!blocks_cnt) {
printf("please, specify valid blocks count number\n");
exit(1);
}
frame_out_p = calloc(sizeof(*frame_out_p), blocks_cnt);
if (!frame_out_p) {
printf("can't allocate memory for RPMB outer frames\n");
exit(1);
}
/* Write 256b data */
if (0 == strcmp(argv[4], "-"))
data_fd = STDOUT_FILENO;
else {
data_fd = open(argv[4], O_WRONLY | O_CREAT | O_APPEND,
S_IRUSR | S_IWUSR);
if (data_fd < 0) {
perror("can't open output file");
exit(1);
}
}
/* Key is specified */
if (nargs == 6) {
if (0 == strcmp(argv[5], "-"))
key_fd = STDIN_FILENO;
else {
key_fd = open(argv[5], O_RDONLY);
if (key_fd < 0) {
perror("can't open input key file");
exit(1);
}
}
ret = DO_IO(read, key_fd, key, sizeof(key));
if (ret < 0) {
perror("read the key data");
exit(1);
} else if (ret != sizeof(key)) {
printf("Data must be %lu bytes length, but we read only %d, exit\n",
(unsigned long)sizeof(key),
ret);
exit(1);
}
}
/* Execute RPMB op */
ret = do_rpmb_op(dev_fd, &frame_in, frame_out_p, blocks_cnt);
if (ret != 0) {
perror("RPMB ioctl failed");
exit(1);
}
/* Check RPMB response */
if (frame_out_p[blocks_cnt - 1].result != 0) {
printf("RPMB operation failed, retcode 0x%04x\n",
be16toh(frame_out_p[blocks_cnt - 1].result));
exit(1);
}
/* Do we have to verify data against key? */
if (nargs == 6) {
unsigned char mac[32];
hmac_sha256_ctx ctx;
struct rpmb_frame *frame_out = NULL;
hmac_sha256_init(&ctx, key, sizeof(key));
for (i = 0; i < blocks_cnt; i++) {
frame_out = &frame_out_p[i];
hmac_sha256_update(&ctx, frame_out->data,
sizeof(*frame_out) -
offsetof(struct rpmb_frame, data));
}
hmac_sha256_final(&ctx, mac, sizeof(mac));
/* Impossible */
assert(frame_out);
/* Compare calculated MAC and MAC from last frame */
if (memcmp(mac, frame_out->key_mac, sizeof(mac))) {
printf("RPMB MAC missmatch\n");
exit(1);
}
}
/* Write data */
for (i = 0; i < blocks_cnt; i++) {
struct rpmb_frame *frame_out = &frame_out_p[i];
ret = DO_IO(write, data_fd, frame_out->data, sizeof(frame_out->data));
if (ret < 0) {
perror("write the data");
exit(1);
} else if (ret != sizeof(frame_out->data)) {
printf("Data must be %lu bytes length, but we wrote only %d, exit\n",
(unsigned long)sizeof(frame_out->data),
ret);
exit(1);
}
}
free(frame_out_p);
close(dev_fd);
if (data_fd != STDOUT_FILENO)
close(data_fd);
if (key_fd != -1 && key_fd != STDIN_FILENO)
close(key_fd);
return ret;
}
int do_rpmb_write_block(int nargs, char **argv)
{
int ret, dev_fd, key_fd, data_fd;
unsigned char key[32];
uint16_t addr;
unsigned int cnt;
struct rpmb_frame frame_in = {
.req_resp = htobe16(MMC_RPMB_WRITE),
.block_count = htobe16(1)
}, frame_out;
CHECK(nargs != 5, "Usage: mmc rpmb write-block </path/to/mmcblkXrpmb> <address> </path/to/input_file> </path/to/key>\n",
exit(1));
dev_fd = open(argv[1], O_RDWR);
if (dev_fd < 0) {
perror("device open");
exit(1);
}
ret = rpmb_read_counter(dev_fd, &cnt);
/* Check RPMB response */
if (ret != 0) {
printf("RPMB read counter operation failed, retcode 0x%04x\n", ret);
exit(1);
}
frame_in.write_counter = htobe32(cnt);
/* Get block address */
errno = 0;
addr = strtol(argv[2], NULL, 0);
if (errno) {
perror("incorrect address");
exit(1);
}
frame_in.addr = htobe16(addr);
/* Read 256b data */
if (0 == strcmp(argv[3], "-"))
data_fd = STDIN_FILENO;
else {
data_fd = open(argv[3], O_RDONLY);
if (data_fd < 0) {
perror("can't open input file");
exit(1);
}
}
ret = DO_IO(read, data_fd, frame_in.data, sizeof(frame_in.data));
if (ret < 0) {
perror("read the data");
exit(1);
} else if (ret != sizeof(frame_in.data)) {
printf("Data must be %lu bytes length, but we read only %d, exit\n",
(unsigned long)sizeof(frame_in.data),
ret);
exit(1);
}
/* Read the auth key */
if (0 == strcmp(argv[4], "-"))
key_fd = STDIN_FILENO;
else {
key_fd = open(argv[4], O_RDONLY);
if (key_fd < 0) {
perror("can't open key file");
exit(1);
}
}
ret = DO_IO(read, key_fd, key, sizeof(key));
if (ret < 0) {
perror("read the key");
exit(1);
} else if (ret != sizeof(key)) {
printf("Auth key must be %lu bytes length, but we read only %d, exit\n",
(unsigned long)sizeof(key),
ret);
exit(1);
}
/* Calculate HMAC SHA256 */
hmac_sha256(
key, sizeof(key),
frame_in.data, sizeof(frame_in) - offsetof(struct rpmb_frame, data),
frame_in.key_mac, sizeof(frame_in.key_mac));
/* Execute RPMB op */
ret = do_rpmb_op(dev_fd, &frame_in, &frame_out, 1);
if (ret != 0) {
perror("RPMB ioctl failed");
exit(1);
}
/* Check RPMB response */
if (frame_out.result != 0) {
printf("RPMB operation failed, retcode 0x%04x\n",
be16toh(frame_out.result));
exit(1);
}
close(dev_fd);
if (data_fd != STDIN_FILENO)
close(data_fd);
if (key_fd != STDIN_FILENO)
close(key_fd);
return ret;
}
mmc_cmds.h
View file @ c6cb053e
......@@ -28,3 +28,7 @@ int do_sanitize(int nargs, char **argv);
int do_status_get(int nargs, char **argv);
int do_enh_area_set(int nargs, char **argv);
int do_write_reliability_set(int nargs, char **argv);
int do_rpmb_write_key(int nargs, char **argv);
int do_rpmb_read_counter(int nargs, char **argv);
int do_rpmb_read_block(int nargs, char **argv);
int do_rpmb_write_block(int nargs, char **argv);
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment