tests/pkcs11/pkcs11-hmacmd5.c

	pkcs11-hmacmd5.c revision e20788e1216ed720aefa84f3295f7899d9f28c22
/*
 * Copyright (C) 2014  Internet Systems Consortium, Inc. ("ISC")
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * Portions copyright (c) 2008 Nominet UK.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* $Id$ */

/*
 * pkcs11-hmacmd5
 *
 * Prints the MD5 HMAC of the standard input, using the PKCS#11 device.
 *
 * Usage:
 * pkcs11-hmacmd5 [-m module] [-s $slot] [-n] [-p $pin]
 *  -m: PKCS#11 provider module.  This must be the full
 *      path to a shared library object implementing the
 *      PKCS#11 API for a device.
 *  -s: Slot
 *  -p: PIN
 *  -n: don't log in to the PKCS#11 device
 *  -k: key name for the HMAC
 */

/*! \file */

#include <config.h>

#include <stdio.h>
#include <stdlib.h>
#include <fcntl.h>
#include <errno.h>
#include <string.h>
#include <sys/types.h>

#include <isc/commandline.h>
#include <isc/result.h>
#include <isc/types.h>

#include <iscpk11/pk11.h>

#if !(defined(HAVE_GETPASSPHRASE) || (defined (__SVR4) && defined (__sun)))
#define getpassphrase(x)    getpass(x)
#endif

/* Define static key template values */
static CK_BBOOL truevalue = TRUE;
static CK_BBOOL falsevalue = FALSE;

#define BLOCKSIZE   32768

char buffer[BLOCKSIZE + 72];
char digest[16];

int
main(int argc, char *argv[]) {
    isc_result_t result;
    CK_RV rv;
    CK_SLOT_ID slot = 0;
    CK_SESSION_HANDLE hSession;
    CK_MECHANISM mech = { CKM_MD5_HMAC, NULL, 0 };
    CK_ULONG len;
    CK_OBJECT_HANDLE hKey = CK_INVALID_HANDLE;
    CK_OBJECT_CLASS keyClass = CKO_SECRET_KEY;
    CK_KEY_TYPE keyType = CKK_MD5_HMAC;
    CK_ATTRIBUTE keyTemplate[] =
    {
        { CKA_CLASS, &keyClass, (CK_ULONG) sizeof(keyClass) },
        { CKA_KEY_TYPE, &keyType, (CK_ULONG) sizeof(keyType) },
        { CKA_TOKEN, &falsevalue, (CK_ULONG) sizeof(falsevalue) },
        { CKA_PRIVATE, &falsevalue, (CK_ULONG) sizeof(falsevalue) },
        { CKA_SIGN, &truevalue, (CK_ULONG) sizeof(truevalue) },
        { CKA_VALUE, NULL, 0 }
    };
    iscpk11_context_t pctx;
    char *lib_name = NULL;
    char *pin = NULL;
    int error = 0;
    isc_boolean_t logon = ISC_TRUE;
    int c, errflg = 0;
    char *key = NULL;
    size_t sum = 0;
    unsigned int i;

    while ((c = isc_commandline_parse(argc, argv, ":m:s:np:k:")) != -1) {
        switch (c) {
        case 'm':
            lib_name = isc_commandline_argument;
            break;
        case 's':
            slot = atoi(isc_commandline_argument);
            break;
        case 'n':
            logon = ISC_FALSE;
            break;
        case 'p':
            pin = isc_commandline_argument;
            break;
        case 'k':
            key = isc_commandline_argument;
            break;
        case ':':
            fprintf(stderr,
                "Option -%c requires an operand\n",
                isc_commandline_option);
            errflg++;
            break;
        case '?':
        default:
            fprintf(stderr, "Unrecognised option: -%c\n",
                isc_commandline_option);
            errflg++;
        }
    }

    if (errflg || (key == NULL)) {
        fprintf(stderr, "Usage:\n");
        fprintf(stderr,
            "\tpkcs11-hmacmd5 [-m module] [-s slot] "
            "[-n|-p pin] -k key\n");
        exit(1);
    }

    /* Decode the key */
    for (i = 0; i < BLOCKSIZE / 2; i++) {
        switch (c = *key++) {
        case 0:
            goto key_done;
        case '0':
        case '1':
        case '2':
        case '3':
        case '4':
        case '5':
        case '6':
        case '7':
        case '8':
        case '9':
            if ((i & 1) == 0)
                buffer[i >> 1] = (c - '0') << 4;
            else
                buffer[i >> 1] |= c - '0';
            break;
        case 'A':
        case 'B':
        case 'C':
        case 'D':
        case 'E':
        case 'F':
            if ((i & 1) == 0)
                buffer[i >> 1] = (c - 'A' + 10) << 4;
            else
                buffer[i >> 1] |= c - 'A' + 10;
            break;
        case 'a':
        case 'b':
        case 'c':
        case 'd':
        case 'e':
        case 'f':
            if ((i & 1) == 0)
                buffer[i >> 1] = (c - 'a' + 10) << 4;
            else
                buffer[i >> 1] |= c - 'a' + 10;
            break;
        default:
            fprintf(stderr, "Not hexdigit '%c' in key\n", c);
            exit(1);
        }
    }
    key_done:
    if ((i & 1) != 0) {
        fprintf(stderr, "Even number of hexdigits in key\n");
        exit(1);
    }
    len = i >> 1;
    keyTemplate[5].pValue = buffer;
    keyTemplate[5].ulValueLen = (CK_ULONG) len;

    /* Initialize the CRYPTOKI library */
    if (lib_name != NULL)
        pk11_set_lib_name(lib_name);

    if (logon && pin == NULL)
        pin = getpassphrase("Enter Pin: ");

    result = pk11_get_session(&pctx, OP_ANY, ISC_FALSE, logon,
                  (const char *) pin, slot);
    if (result != ISC_R_SUCCESS) {
        fprintf(stderr, "Error initializing PKCS#11: %s\n",
            isc_result_totext(result));
        exit(1);
    }

    if (pin != NULL)
        memset(pin, 0, strlen((char *)pin));

    hSession = pctx.session;

    rv = pkcs_C_CreateObject(hSession, keyTemplate, (CK_ULONG) 6, &hKey);
    if (rv != CKR_OK) {
        fprintf(stderr, "C_CreateObject: Error = 0x%.8lX\n", rv);
        error = 1;
        goto exit_session;
    }
    if (hKey == CK_INVALID_HANDLE) {
        fprintf(stderr, "C_CreateObject failed\n");
        error = 1;
        goto exit_session;
    }

    rv = pkcs_C_SignInit(hSession, &mech, hKey);
    if (rv != CKR_OK) {
        fprintf(stderr, "C_SignInit: Error = 0x%.8lX\n", rv);
        error = 1;
        goto exit_sign;
    }

    for (;;) {
        size_t n;

        for (;;) {
            n = fread(buffer + sum, 1, BLOCKSIZE - sum, stdin);
            sum += n;
            if (sum == BLOCKSIZE)
                break;
            if (n == 0) {
                if (ferror(stdin)) {
                    fprintf(stderr, "fread failed\n");
                    error = 1;
                    goto exit_sign;
                }
                goto partial_block;
            }
            if (feof(stdin))
                goto partial_block;
        }

        rv = pkcs_C_SignUpdate(hSession, (CK_BYTE_PTR) buffer,
                       (CK_ULONG) BLOCKSIZE);
        if (rv != CKR_OK) {
            fprintf(stderr,
                "C_SignUpdate: Error = 0x%.8lX\n",
                rv);
            error = 1;
            goto exit_sign;
        }
    }

partial_block:
    if (sum > 0) {
        rv = pkcs_C_SignUpdate(hSession, (CK_BYTE_PTR) buffer,
                       (CK_ULONG) sum);
        if (rv != CKR_OK) {
            fprintf(stderr,
                "C_SignUpdate: Error = 0x%.8lX\n",
                rv);
            error = 1;
            goto exit_sign;
        }
    }

    len = 16;
    rv = pkcs_C_SignFinal(hSession, (CK_BYTE_PTR) digest, &len);
    if (rv != CKR_OK) {
        fprintf(stderr, "C_SignFinal: Error = 0x%.8lX\n", rv);
        error = 1;
        goto exit_sign;
    }
    if (len != 16) {
        fprintf(stderr, "C_SignFinal: bad length = %lu\n", len);
        error = 1;
    }

    for (i = 0; i < 16; i++)
        printf("%02x", digest[i] & 0xff);
    printf("\n");

    exit_sign:
    rv = pkcs_C_DestroyObject(hSession, hKey);
    if ((error == 0) && (rv != CKR_OK)) {
        fprintf(stderr, "C_DestroyObject: Error = 0x%.8lX\n", rv);
        error = 1;
    }

    exit_session:
    pk11_return_session(&pctx);
    pk11_shutdown();

    exit(error);
}