pkcs11_tpm/common/template.c

/*
 *      Common Public License Version 0.5
 *
 *      THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF
 *      THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE,
 *      REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
 *      RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
 *
 *      1. DEFINITIONS
 *
 *      "Contribution" means:
 *            a) in the case of the initial Contributor, the
 *            initial code and documentation distributed under
 *            this Agreement, and
 *
 *            b) in the case of each subsequent Contributor:
 *            i) changes to the Program, and
 *            ii) additions to the Program;
 *
 *            where such changes and/or additions to the Program
 *            originate from and are distributed by that
 *            particular Contributor. A Contribution 'originates'
 *            from a Contributor if it was added to the Program
 *            by such Contributor itself or anyone acting on such
 *            Contributor's behalf. Contributions do not include
 *            additions to the Program which: (i) are separate
 *            modules of software distributed in conjunction with
 *            the Program under their own license agreement, and
 *            (ii) are not derivative works of the Program.
 *
 *
 *      "Contributor" means any person or entity that distributes
 *      the Program.
 *
 *      "Licensed Patents " mean patent claims licensable by a
 *      Contributor which are necessarily infringed by the use or
 *      sale of its Contribution alone or when combined with the
 *      Program.
 *
 *      "Program" means the Contributions distributed in
 *      accordance with this Agreement.
 *
 *      "Recipient" means anyone who receives the Program under
 *      this Agreement, including all Contributors.
 *
 *      2. GRANT OF RIGHTS
 *
 *            a) Subject to the terms of this Agreement, each
 *            Contributor hereby grants Recipient a
 *            no - exclusive, worldwide, royalt - free copyright
 *            license to reproduce, prepare derivative works of,
 *            publicly display, publicly perform, distribute and
 *            sublicense the Contribution of such Contributor, if
 *            any, and such derivative works, in source code and
 *            object code form.
 *
 *            b) Subject to the terms of this Agreement, each
 *            Contributor hereby grants Recipient a
 *            no - exclusive, worldwide, royalt - free patent
 *            license under Licensed Patents to make, use, sell,
 *            offer to sell, import and otherwise transfer the
 *            Contribution of such Contributor, if any, in source
 *            code and object code form. This patent license
 *            shall apply to the combination of the Contribution
 *            and the Program if, at the time the Contribution is
 *            added by the Contributor, such addition of the
 *            Contribution causes such combination to be covered
 *            by the Licensed Patents. The patent license shall
 *            not apply to any other combinations which include
 *            the Contribution. No hardware per se is licensed
 *            hereunder.
 *
 *            c) Recipient understands that although each
 *            Contributor grants the licenses to its
 *            Contributions set forth herein, no assurances are
 *            provided by any Contributor that the Program does
 *            not infringe the patent or other intellectual
 *            property rights of any other entity. Each
 *            Contributor disclaims any liability to Recipient
 *            for claims brought by any other entity based on
 *            infringement of intellectual property rights or
 *            otherwise. As a condition to exercising the rights
 *            and licenses granted hereunder, each Recipient
 *            hereby assumes sole responsibility to secure any
 *            other intellectual property rights needed, if any.
 *
 *            For example, if a third party patent license is
 *            required to allow Recipient to distribute the
 *            Program, it is Recipient's responsibility to
 *            acquire that license before distributing the
 *            Program.
 *
 *            d) Each Contributor represents that to its
 *            knowledge it has sufficient copyright rights in its
 *            Contribution, if any, to grant the copyright
 *            license set forth in this Agreement.
 *
 *      3. REQUIREMENTS
 *
 *      A Contributor may choose to distribute the Program in
 *      object code form under its own license agreement, provided
 *      that:
 *            a) it complies with the terms and conditions of
 *            this Agreement; and
 *
 *            b) its license agreement:
 *            i) effectively disclaims on behalf of all
 *            Contributors all warranties and conditions, express
 *            and implied, including warranties or conditions of
 *            title and no - infringement, and implied warranties
 *            or conditions of merchantability and fitness for a
 *            particular purpose;
 *
 *            ii) effectively excludes on behalf of all
 *            Contributors all liability for damages, including
 *            direct, indirect, special, incidental and
 *            consequential damages, such as lost profits;
 *
 *            iii) states that any provisions which differ from
 *            this Agreement are offered by that Contributor
 *            alone and not by any other party; and
 *
 *            iv) states that source code for the Program is
 *            available from such Contributor, and informs
 *            licensees how to obtain it in a reasonable manner
 *            on or through a medium customarily used for
 *            software exchange.
 *
 *      When the Program is made available in source code form:
 *            a) it must be made available under this Agreement;
 *            and
 *            b) a copy of this Agreement must be included with
 *            each copy of the Program.
 *
 *      Contributors may not remove or alter any copyright notices
 *      contained within the Program.
 *
 *      Each Contributor must identify itself as the originator of
 *      its Contribution, if any, in a manner that reasonably
 *      allows subsequent Recipients to identify the originator of
 *      the Contribution.
 *
 *
 *      4. COMMERCIAL DISTRIBUTION
 *
 *      Commercial distributors of software may accept certain
 *      responsibilities with respect to end users, business
 *      partners and the like. While this license is intended to
 *      facilitate the commercial use of the Program, the
 *      Contributor who includes the Program in a commercial
 *      product offering should do so in a manner which does not
 *      create potential liability for other Contributors.
 *      Therefore, if a Contributor includes the Program in a
 *      commercial product offering, such Contributor ("Commercial
 *      Contributor") hereby agrees to defend and indemnify every
 *      other Contributor ("Indemnified Contributor") against any
 *      losses, damages and costs (collectively "Losses") arising
 *      from claims, lawsuits and other legal actions brought by a
 *      third party against the Indemnified Contributor to the
 *      extent caused by the acts or omissions of such Commercial
 *      Contributor in connection with its distribution of the
 *      Program in a commercial product offering. The obligations
 *      in this section do not apply to any claims or Losses
 *      relating to any actual or alleged intellectual property
 *      infringement. In order to qualify, an Indemnified
 *      Contributor must: a) promptly notify the Commercial
 *      Contributor in writing of such claim, and b) allow the
 *      Commercial Contributor to control, and cooperate with the
 *      Commercial Contributor in, the defense and any related
 *      settlement negotiations. The Indemnified Contributor may
 *      participate in any such claim at its own expense.
 *
 *
 *      For example, a Contributor might include the Program in a
 *      commercial product offering, Product X. That Contributor
 *      is then a Commercial Contributor. If that Commercial
 *      Contributor then makes performance claims, or offers
 *      warranties related to Product X, those performance claims
 *      and warranties are such Commercial Contributor's
 *      responsibility alone. Under this section, the Commercial
 *      Contributor would have to defend claims against the other
 *      Contributors related to those performance claims and
 *      warranties, and if a court requires any other Contributor
 *      to pay any damages as a result, the Commercial Contributor
 *      must pay those damages.
 *
 *
 *      5. NO WARRANTY
 *
 *      EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE
 *      PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT
 *      WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
 *      IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR
 *      CONDITIONS OF TITLE, NO - INFRINGEMENT, MERCHANTABILITY OR
 *      FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely
 *      responsible for determining the appropriateness of using
 *      and distributing the Program and assumes all risks
 *      associated with its exercise of rights under this
 *      Agreement, including but not limited to the risks and
 *      costs of program errors, compliance with applicable laws,
 *      damage to or loss of data, programs or equipment, and
 *      unavailability or interruption of operations.
 *
 *      6. DISCLAIMER OF LIABILITY
 *      EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER
 *      RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY
 *      FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 *      OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
 *      LOST PROFITS), 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 OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE
 *      OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
 *      POSSIBILITY OF SUCH DAMAGES.
 *
 *      7. GENERAL
 *
 *      If any provision of this Agreement is invalid or
 *      unenforceable under applicable law, it shall not affect
 *      the validity or enforceability of the remainder of the
 *      terms of this Agreement, and without further action by the
 *      parties hereto, such provision shall be reformed to the
 *      minimum extent necessary to make such provision valid and
 *      enforceable.
 *
 *
 *      If Recipient institutes patent litigation against a
 *      Contributor with respect to a patent applicable to
 *      software (including a cros - claim or counterclaim in a
 *      lawsuit), then any patent licenses granted by that
 *      Contributor to such Recipient under this Agreement shall
 *      terminate as of the date such litigation is filed. In
 *      addition, If Recipient institutes patent litigation
 *      against any entity (including a cros - claim or
 *      counterclaim in a lawsuit) alleging that the Program
 *      itself (excluding combinations of the Program with other
 *      software or hardware) infringes such Recipient's
 *      patent(s), then such Recipient's rights granted under
 *      Section 2(b) shall terminate as of the date such
 *      litigation is filed.
 *
 *      All Recipient's rights under this Agreement shall
 *      terminate if it fails to comply with any of the material
 *      terms or conditions of this Agreement and does not cure
 *      such failure in a reasonable period of time after becoming
 *      aware of such noncompliance. If all Recipient's rights
 *      under this Agreement terminate, Recipient agrees to cease
 *      use and distribution of the Program as soon as reasonably
 *      practicable. However, Recipient's obligations under this
 *      Agreement and any licenses granted by Recipient relating
 *      to the Program shall continue and survive.
 *
 *      Everyone is permitted to copy and distribute copies of
 *      this Agreement, but in order to avoid inconsistency the
 *      Agreement is copyrighted and may only be modified in the
 *      following manner. The Agreement Steward reserves the right
 *      to publish new versions (including revisions) of this
 *      Agreement from time to time. No one other than the
 *      Agreement Steward has the right to modify this Agreement.
 *
 *      IBM is the initial Agreement Steward. IBM may assign the
 *      responsibility to serve as the Agreement Steward to a
 *      suitable separate entity. Each new version of the
 *      Agreement will be given a distinguishing version number.
 *      The Program (including Contributions) may always be
 *      distributed subject to the version of the Agreement under
 *      which it was received. In addition, after a new version of
 *      the Agreement is published, Contributor may elect to
 *      distribute the Program (including its Contributions) under
 *      the new version. Except as expressly stated in Sections
 *      2(a) and 2(b) above, Recipient receives no rights or
 *      licenses to the intellectual property of any Contributor
 *      under this Agreement, whether expressly, by implication,
 *      estoppel or otherwise. All rights in the Program not
 *      expressly granted under this Agreement are reserved.
 *
 *
 *      This Agreement is governed by the laws of the State of New
 *      York and the intellectual property laws of the United
 *      States of America. No party to this Agreement will bring a
 *      legal action under this Agreement more than one year after
 *      the cause of action arose. Each party waives its rights to
 *      a jury trial in any resulting litigation.
 *
 *
 *
 * (C) COPYRIGHT International Business Machines Corp. 2001, 2002
 */
/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#include "tpmtok_int.h"

// template_add_attributes()
//
// blindly add the given attributes to the template.  do no sanity checking
// at this point.  sanity checking will occur later.
//
CK_RV
template_add_attributes(TEMPLATE    * tmpl,
    CK_ATTRIBUTE * pTemplate,
    CK_ULONG    ulCount)
{
    CK_ATTRIBUTE  * attr = NULL;
    CK_RV      rc;
    unsigned int    i;

    for (i = 0; i < ulCount; i++) {
        if (! is_attribute_defined(pTemplate[i].type)) {
            return (CKR_ATTRIBUTE_TYPE_INVALID);
        }
        attr = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
            pTemplate[i].ulValueLen);
        if (! attr) {
            return (CKR_HOST_MEMORY);
        }
        attr->type  = pTemplate[i].type;
        attr->ulValueLen = pTemplate[i].ulValueLen;

        if (attr->ulValueLen != 0) {
            attr->pValue = (CK_BYTE *)attr + sizeof (CK_ATTRIBUTE);
            (void) memcpy(attr->pValue, pTemplate[i].pValue,
                attr->ulValueLen);
        } else
            attr->pValue = NULL;

        rc = template_update_attribute(tmpl, attr);
        if (rc != CKR_OK) {
            free(attr);
            return (rc);
        }
    }

    return (CKR_OK);
}


// template_add_default_attributes()
//
CK_RV
template_add_default_attributes(TEMPLATE * tmpl,
    CK_ULONG   class,
    CK_ULONG   subclass,
    CK_ULONG   mode)
{
    CK_RV rc;

    // first add the default common attributes
    //
    rc = template_set_default_common_attributes(tmpl);
    if (rc != CKR_OK) {
        return (rc);
    }
    // set the template class - specific default attributes
    //
    switch (class) {
        case CKO_DATA:
        return (data_object_set_default_attributes(tmpl, mode));
        case CKO_CERTIFICATE:
        if (subclass == CKC_X_509)
            return (cert_x509_set_default_attributes(tmpl, mode));
        else
            return (CKR_OK);
        case CKO_PUBLIC_KEY:
        switch (subclass) {
            case CKK_RSA:
                return (rsa_publ_set_default_attributes(
                    tmpl, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }

        case CKO_PRIVATE_KEY:
        switch (subclass) {
            case CKK_RSA:
                return (rsa_priv_set_default_attributes(
                    tmpl, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }

        case CKO_SECRET_KEY:
        switch (subclass) {
            case CKK_GENERIC_SECRET:
                return (generic_secret_set_default_attributes(
                    tmpl, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }

        case CKO_HW_FEATURE:
        switch (subclass) {
            case CKH_CLOCK:
                return (clock_set_default_attributes(
                    tmpl));
            case CKH_MONOTONIC_COUNTER:
                return (counter_set_default_attributes(
                    tmpl));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }

        case CKO_DOMAIN_PARAMETERS:
        switch (subclass) {
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }

        default:
            return (CKR_ATTRIBUTE_VALUE_INVALID);
    }
}

// template_attribute_find()
//
// find the attribute in the list and return (its value
//
CK_BBOOL
template_attribute_find(TEMPLATE       * tmpl,
    CK_ATTRIBUTE_TYPE    type,
    CK_ATTRIBUTE    ** attr)
{
    DL_NODE * node = NULL;
    CK_ATTRIBUTE * a    = NULL;

    if (! tmpl || ! attr)
        return (FALSE);
    node = tmpl->attribute_list;

    while (node != NULL) {
        a = (CK_ATTRIBUTE *)node->data;

        if (type == a->type) {
            *attr = a;
            return (TRUE);
        }

        node = node->next;
    }

    *attr = NULL;
    return (FALSE);
}

// template_attribute_find_multiple()
//
// find the attributes in the list and return (their values
//
void
template_attribute_find_multiple(TEMPLATE       * tmpl,
    ATTRIBUTE_PARSE_LIST * parselist,
    CK_ULONG        plcount)
{
    CK_ATTRIBUTE  * attr = NULL;
    CK_ULONG    i;

    for (i = 0; i < plcount; i++) {
        parselist[i].found = template_attribute_find(
            tmpl, parselist[i].type, &attr);

        if (parselist[i].found && parselist[i].ptr != NULL)
            (void) memcpy(parselist[i].ptr, attr->pValue,
                parselist[i].len);
    }
}

CK_RV
template_check_required_attributes(TEMPLATE  * tmpl,
    CK_ULONG    class,
    CK_ULONG    subclass,
    CK_ULONG    mode)
{
    if (class == CKO_DATA)
        return (data_object_check_required_attributes(
            tmpl, mode));
    else if (class == CKO_CERTIFICATE) {
        if (subclass == CKC_X_509)
            return (cert_x509_check_required_attributes(
                tmpl, mode));
        else
            return (cert_vendor_check_required_attributes(
                tmpl, mode));
    } else if (class == CKO_PUBLIC_KEY) {
        switch (subclass) {
            case CKK_RSA:
                return (rsa_publ_check_required_attributes(
                    tmpl, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    } else if (class == CKO_PRIVATE_KEY) {
        switch (subclass) {
            case CKK_RSA:
                return (rsa_priv_check_required_attributes(
                    tmpl, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    } else if (class == CKO_SECRET_KEY) {
        switch (subclass) {
            case CKK_GENERIC_SECRET:
                return (
                    generic_secret_check_required_attributes(
                    tmpl, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    } else if (class == CKO_HW_FEATURE) {

        switch (subclass) {
            case CKH_CLOCK:
                return (
                    clock_check_required_attributes(
                    tmpl, mode));
            case CKH_MONOTONIC_COUNTER:
                return (
                    counter_check_required_attributes(
                    tmpl, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    } else if (class == CKO_DOMAIN_PARAMETERS) {
        switch (subclass) {
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    }
    return (CKR_ATTRIBUTE_VALUE_INVALID);
}


// template_check_required_base_attributes()
//
// check to make sure that attributes required by Cryptoki are
// present.  does not check to see if the attribute makes sense
// for the particular object (that is done in the 'validate' routines)
//
CK_RV
template_check_required_base_attributes(TEMPLATE * tmpl,
CK_ULONG   mode)
{
    CK_ATTRIBUTE  * attr;
    CK_BBOOL    found;

    found = template_attribute_find(tmpl, CKA_CLASS, &attr);
    if (mode == MODE_CREATE && found == FALSE)
        return (CKR_TEMPLATE_INCOMPLETE);
    return (CKR_OK);
}


// template_compare()
//
CK_BBOOL
template_compare(CK_ATTRIBUTE  * t1,
    CK_ULONG    ulCount,
    TEMPLATE    * t2) {
    CK_ATTRIBUTE  * attr1 = NULL;
    CK_ATTRIBUTE  * attr2 = NULL;
    CK_ULONG    i;
    CK_RV      rc;

    if (! t1 || ! t2)
        return (FALSE);
    attr1 = t1;

    for (i = 0; i < ulCount; i++) {
        rc = template_attribute_find(t2, attr1->type, &attr2);
        if (rc == FALSE)
            return (FALSE);
        if (attr1->ulValueLen != attr2->ulValueLen)
            return (FALSE);
        if (memcmp(attr1->pValue, attr2->pValue, attr1->ulValueLen)
            != 0)
            return (FALSE);
        attr1++;
    }

    return (TRUE);
}

// template_copy()
//
// This doesn't copy the template items verbatim.  The new template is in
// the reverse order of the old one.  This should not have any effect.
//
// This is very similar to template_merge().  template_merge() can also
// be used to copy a list (of unique attributes) but is slower because for
// each attribute, it must search through the list.
//
CK_RV
template_copy(TEMPLATE *dest, TEMPLATE *src) {
    DL_NODE  *node;

    if (! dest || ! src) {
        return (CKR_FUNCTION_FAILED);
    }
    node = src->attribute_list;

    while (node) {
        CK_ATTRIBUTE *attr  = (CK_ATTRIBUTE *)node->data;
        CK_ATTRIBUTE *new_attr = NULL;
        CK_ULONG    len;

        len = sizeof (CK_ATTRIBUTE) + attr->ulValueLen;

        new_attr = (CK_ATTRIBUTE *)malloc(len);
        if (! new_attr) {
            return (CKR_HOST_MEMORY);
        }
        (void) memcpy(new_attr, attr, len);

        new_attr->pValue = (CK_BYTE *)new_attr + sizeof (CK_ATTRIBUTE);

        dest->attribute_list = dlist_add_as_first(dest->attribute_list,
            new_attr);

        node = node->next;
    }

    return (CKR_OK);
}


// template_flatten() - this still gets used when saving token objects to disk
//
CK_RV
template_flatten(TEMPLATE  * tmpl,
    CK_BYTE   * dest)
{
    DL_NODE   * node = NULL;
    CK_BYTE   * ptr = NULL;
    CK_ULONG_32 long_len;
    CK_ATTRIBUTE_32 *attr_32;
    CK_ULONG    Val;
    CK_ULONG_32 Val_32;
    CK_ULONG  * pVal;
    long_len = sizeof (CK_ULONG);

    if (! tmpl || ! dest) {
        return (CKR_FUNCTION_FAILED);
    }
    ptr = dest;
    node = tmpl->attribute_list;
    while (node) {
        CK_ATTRIBUTE *attr = (CK_ATTRIBUTE *)node->data;

        if (long_len == 4) {
            (void) memcpy(ptr, attr, sizeof (CK_ATTRIBUTE) +
                attr->ulValueLen);
            ptr += sizeof (CK_ATTRIBUTE) + attr->ulValueLen;
        } else {
            attr_32 = malloc(sizeof (CK_ATTRIBUTE_32));
            if (! attr_32) {
                return (CKR_HOST_MEMORY);
            }
            attr_32->type = attr->type;
            attr_32->pValue = 0x00;
            if ((attr->type == CKA_CLASS ||
                attr->type == CKA_KEY_TYPE ||
                attr->type == CKA_MODULUS_BITS ||
                attr->type == CKA_VALUE_BITS ||
                attr->type == CKA_CERTIFICATE_TYPE ||
                attr->type == CKA_VALUE_LEN) &&
                attr->ulValueLen != 0) {

                attr_32->ulValueLen = sizeof (CK_ULONG_32);

                (void) memcpy(ptr, attr_32,
                    sizeof (CK_ATTRIBUTE_32));
                ptr += sizeof (CK_ATTRIBUTE_32);

                pVal = (CK_ULONG *)attr->pValue;
                Val = *pVal;
                Val_32 = (CK_ULONG_32)Val;
                (void) memcpy(ptr, &Val_32,
                    sizeof (CK_ULONG_32));
                ptr += sizeof (CK_ULONG_32);
            } else {
                attr_32->ulValueLen = attr->ulValueLen;
                (void) memcpy(ptr, attr_32,
                    sizeof (CK_ATTRIBUTE_32));
                ptr += sizeof (CK_ATTRIBUTE_32);
                if (attr->ulValueLen != 0) {
                    (void) memcpy(ptr, attr->pValue,
                        attr->ulValueLen);
                    ptr += attr->ulValueLen;
                }
            }
            free(attr_32);
        }
        node = node->next;
    }

    return (CKR_OK);
}

CK_RV
template_unflatten(TEMPLATE ** new_tmpl,
    CK_BYTE   * buf,
    CK_ULONG    count)
{
    TEMPLATE    * tmpl = NULL;
    CK_ATTRIBUTE  * a2   = NULL;
    CK_BYTE *ptr  = NULL;
    CK_ULONG    i, len;
    CK_RV      rc;
    CK_ULONG_32 long_len = sizeof (CK_ULONG);
    CK_ULONG_32 attr_ulong_32;
    CK_ULONG    attr_ulong;
    CK_ATTRIBUTE * a1_64 = NULL;
    CK_ATTRIBUTE_32 * a1 = NULL;

    if (! new_tmpl || ! buf) {
        return (CKR_FUNCTION_FAILED);
    }
    tmpl = (TEMPLATE *)malloc(sizeof (TEMPLATE));
    if (! tmpl) {
        return (CKR_HOST_MEMORY);
    }
    (void) memset(tmpl, 0x0, sizeof (TEMPLATE));

    ptr = buf;
    for (i = 0; i < count; i++) {
        if (long_len == 4) {
            void *aptr = ptr;
            a1_64 = (CK_ATTRIBUTE *)aptr;

            len = sizeof (CK_ATTRIBUTE) + a1_64->ulValueLen;
            a2 = (CK_ATTRIBUTE *)malloc(len);
            if (! a2) {
                (void) template_free(tmpl);
                return (CKR_HOST_MEMORY);
            }

            (void) memcpy(a2, a1_64, len);
        } else {
            void *aptr = ptr;
            a1 = (CK_ATTRIBUTE_32 *)aptr;

            if ((a1->type == CKA_CLASS ||
                a1->type == CKA_KEY_TYPE ||
                a1->type == CKA_MODULUS_BITS ||
                a1->type == CKA_VALUE_BITS ||
                a1->type == CKA_CERTIFICATE_TYPE ||
                a1->type == CKA_VALUE_LEN) &&
                a1->ulValueLen != 0) {
                len = sizeof (CK_ATTRIBUTE) + sizeof (CK_ULONG);
            } else {
                len = sizeof (CK_ATTRIBUTE) + a1->ulValueLen;
            }

            a2 = (CK_ATTRIBUTE *)malloc(len);
            if (! a2) {
                return (CKR_HOST_MEMORY);
            }
            a2->type = a1->type;

            if ((a1->type == CKA_CLASS ||
                a1->type == CKA_KEY_TYPE ||
                a1->type == CKA_MODULUS_BITS ||
                a1->type == CKA_VALUE_BITS ||
                a1->type == CKA_CERTIFICATE_TYPE ||
                a1->type == CKA_VALUE_LEN) &&
                a1->ulValueLen != 0) {
                a2->ulValueLen = sizeof (CK_ULONG);
                {
                    CK_ULONG_32 *p32;
                    CK_BYTE *pb2;
                    void *aptr = a1;
                    void *bptr;

                    pb2 = (CK_BYTE *)aptr;
                    pb2 += sizeof (CK_ATTRIBUTE_32);
                    bptr = pb2;
                    p32 = (CK_ULONG_32 *)bptr;
                    attr_ulong_32 = *p32;
                }

                attr_ulong = attr_ulong_32;

                {
                    CK_BYTE *pb2;
                    pb2 = (CK_BYTE *)a2;
                    pb2 += sizeof (CK_ATTRIBUTE);
                    (void) memcpy(pb2,
                        (CK_BYTE *)&attr_ulong,
                        sizeof (CK_ULONG));
                }
            } else {
                CK_BYTE *pb2, *pb;

                a2->ulValueLen = a1->ulValueLen;
                pb2 = (CK_BYTE *)a2;
                pb2 += sizeof (CK_ATTRIBUTE);
                pb = (CK_BYTE *)a1;
                pb += sizeof (CK_ATTRIBUTE_32);
                (void) memcpy(pb2, pb, a1->ulValueLen);
            }
        }


        if (a2->ulValueLen != 0)
            a2->pValue = (CK_BYTE *)a2 + sizeof (CK_ATTRIBUTE);
        else
            a2->pValue = NULL;

        rc = template_update_attribute(tmpl, a2);
        if (rc != CKR_OK) {
            free(a2);
            (void) template_free(tmpl);
            return (rc);
        }
        if (long_len == 4)
            ptr += len;
        else
            ptr += sizeof (CK_ATTRIBUTE_32) + a1->ulValueLen;


    }

        *new_tmpl = tmpl;
    return (CKR_OK);
}

CK_RV
template_free(TEMPLATE *tmpl) {
    if (! tmpl)
        return (CKR_OK);
    while (tmpl->attribute_list) {
        CK_ATTRIBUTE *attr = (CK_ATTRIBUTE *)tmpl->attribute_list->data;

        if (attr)
            free(attr);

        tmpl->attribute_list = dlist_remove_node(tmpl->attribute_list,
        tmpl->attribute_list);
    }

    free(tmpl);
    return (CKR_OK);
}

CK_BBOOL
template_get_class(TEMPLATE  * tmpl,
    CK_ULONG  * class,
    CK_ULONG  * subclass)
{
    DL_NODE * node;
    CK_BBOOL  found;

    if (! tmpl || ! class || ! subclass)
        return (FALSE);
    node = tmpl->attribute_list;

    while (node) {
        CK_ATTRIBUTE *attr = (CK_ATTRIBUTE *)node->data;

        if (attr->type == CKA_CLASS) {
            *class = *(CK_OBJECT_CLASS *)attr->pValue;
            found = TRUE;
        }

        if (attr->type == CKA_CERTIFICATE_TYPE)
            *subclass = *(CK_CERTIFICATE_TYPE *)attr->pValue;

        if (attr->type == CKA_KEY_TYPE)
            *subclass = *(CK_KEY_TYPE *)attr->pValue;

        node = node->next;
    }

    return (found);
}

CK_ULONG
template_get_count(TEMPLATE *tmpl)
{
    if (tmpl == NULL)
        return (0);
    return (dlist_length(tmpl->attribute_list));
}

CK_ULONG
template_get_size(TEMPLATE *tmpl)
{
    DL_NODE   * node;
    CK_ULONG    size = 0;

    if (tmpl == NULL)
        return (0);
    node = tmpl->attribute_list;
    while (node) {
        CK_ATTRIBUTE *attr = (CK_ATTRIBUTE *)node->data;

        size += sizeof (CK_ATTRIBUTE) + attr->ulValueLen;

        node = node->next;
    }

    return (size);
}

CK_ULONG
template_get_compressed_size(TEMPLATE *tmpl)
{
    DL_NODE   * node;
    CK_ULONG    size = 0;

    if (tmpl == NULL)
        return (0);
    node = tmpl->attribute_list;
    while (node) {
        CK_ATTRIBUTE *attr = (CK_ATTRIBUTE *)node->data;

        size += sizeof (CK_ATTRIBUTE_32);
        if ((attr->type == CKA_CLASS ||
            attr->type == CKA_KEY_TYPE ||
            attr->type == CKA_MODULUS_BITS ||
            attr->type == CKA_VALUE_BITS ||
            attr->type == CKA_CERTIFICATE_TYPE ||
            attr->type == CKA_VALUE_LEN) &&
            attr->ulValueLen != 0) {
            size += sizeof (CK_ULONG_32);
        } else {
            size += attr->ulValueLen;
        }

        node = node->next;
    }

    return (size);
}

/*
 * template_is_okay_to_reveal_attribute()
 *
 * determines whether the specified CK_ATTRIBUTE_TYPE is allowed to
 * be leave the card in the clear.  note: the specified template doesn't need
 * to actually posess an attribute of type 'type'.  The template is
 * provided mainly to determine the object class and subclass
 *
 * this routine is called by C_GetAttributeValue which exports the attributes
 * in the clear.  this routine is NOT called when wrapping a key.
 */
CK_BBOOL
template_check_exportability(TEMPLATE *tmpl, CK_ATTRIBUTE_TYPE type)
{
    CK_ATTRIBUTE * attr = NULL;
    CK_ULONG    class;
    CK_ULONG    subclass;
    CK_BBOOL    val;

    if (! tmpl)
        return (FALSE);
    (void) template_get_class(tmpl, &class, &subclass);

    if (class != CKO_PRIVATE_KEY && class != CKO_SECRET_KEY)
        return (TRUE);
    val = template_attribute_find(tmpl, CKA_SENSITIVE, &attr);
    if (val) {
        val = *(CK_BBOOL *)attr->pValue;
        if (val == FALSE)
            return (TRUE);
    } else {
        return (FALSE);
    }

    if (class == CKO_PRIVATE_KEY) {
        switch (subclass) {
            case CKK_RSA:
                return (rsa_priv_check_exportability(type));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    } else if (class == CKO_SECRET_KEY) {
        return (secret_key_check_exportability(type));
    }

    return (CKR_ATTRIBUTE_VALUE_INVALID);
}

CK_RV
template_merge(TEMPLATE *dest, TEMPLATE **src)
{
    DL_NODE  *node;
    CK_RV   rc;

    if (! dest || ! src) {
        return (CKR_FUNCTION_FAILED);
    }
    node = (*src)->attribute_list;

    while (node) {
        CK_ATTRIBUTE *attr = (CK_ATTRIBUTE *)node->data;

        rc = template_update_attribute(dest, attr);
        if (rc != CKR_OK) {
            return (rc);
        }
        node->data = NULL;
        node = node->next;
    }

    (void) template_free(*src);
    *src = NULL;

    return (CKR_OK);
}

/*
 * template_set_default_common_attributes()
 *
 * Set the default attributes common to all objects:
 *
 *    CKA_TOKEN :  FALSE
 *    CKA_PRIVATE    :  TRUE -- Cryptoki leaves this up to the token to decide
 *    CKA_MODIFIABLE :  TRUE
 *    CKA_LABEL :  empty string
 */
CK_RV
template_set_default_common_attributes(TEMPLATE *tmpl)
{
    CK_ATTRIBUTE * token_attr;
    CK_ATTRIBUTE * priv_attr;
    CK_ATTRIBUTE * mod_attr;
    CK_ATTRIBUTE * label_attr;

    token_attr = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
        sizeof (CK_BBOOL));
    priv_attr  = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
        sizeof (CK_BBOOL));
    mod_attr   = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
        sizeof (CK_BBOOL));
    label_attr = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) + 0);

    if (! token_attr || ! priv_attr || ! mod_attr || ! label_attr) {
        if (token_attr) free(token_attr);
        if (priv_attr)  free(priv_attr);
        if (mod_attr)   free(mod_attr);
        if (label_attr) free(label_attr);

        return (CKR_HOST_MEMORY);
    }

    token_attr->type     = CKA_TOKEN;
    token_attr->ulValueLen   = sizeof (CK_BBOOL);
    token_attr->pValue  = (CK_BYTE *)token_attr + sizeof (CK_ATTRIBUTE);
    *(CK_BBOOL *)token_attr->pValue = FALSE;

    priv_attr->type   = CKA_PRIVATE;
    priv_attr->ulValueLen    = sizeof (CK_BBOOL);
    priv_attr->pValue   = (CK_BYTE *)priv_attr + sizeof (CK_ATTRIBUTE);
    *(CK_BBOOL *)priv_attr->pValue = FALSE;

    mod_attr->type     = CKA_MODIFIABLE;
    mod_attr->ulValueLen    = sizeof (CK_BBOOL);
    mod_attr->pValue     = (CK_BYTE *)mod_attr + sizeof (CK_ATTRIBUTE);
    *(CK_BBOOL *)mod_attr->pValue = TRUE;

    label_attr->type     = CKA_LABEL;
    label_attr->ulValueLen   = 0;    // empty string
    label_attr->pValue  = NULL;

    (void) template_update_attribute(tmpl, token_attr);
    (void) template_update_attribute(tmpl, priv_attr);
    (void) template_update_attribute(tmpl, mod_attr);
    (void) template_update_attribute(tmpl, label_attr);

    return (CKR_OK);
}

CK_RV
template_update_attribute(TEMPLATE *tmpl, CK_ATTRIBUTE *new_attr) {
    DL_NODE * node = NULL;
    CK_ATTRIBUTE * attr = NULL;

    if (! tmpl || ! new_attr) {
        return (CKR_FUNCTION_FAILED);
    }
    node = tmpl->attribute_list;

    while (node != NULL) {
        attr = (CK_ATTRIBUTE *)node->data;

        if (new_attr->type == attr->type) {
            free(attr);
            tmpl->attribute_list = dlist_remove_node(
                tmpl->attribute_list, node);
            break;
        }

        node = node->next;
    }

    tmpl->attribute_list = dlist_add_as_first(
        tmpl->attribute_list, new_attr);

    return (CKR_OK);
}

CK_RV
template_validate_attribute(TEMPLATE    * tmpl,
    CK_ATTRIBUTE * attr,
    CK_ULONG    class,
    CK_ULONG    subclass,
    CK_ULONG    mode)
{
    if (class == CKO_DATA)
        return (data_object_validate_attribute(tmpl, attr, mode));
    else if (class == CKO_CERTIFICATE) {
        if (subclass == CKC_X_509)
            return (cert_x509_validate_attribute(tmpl, attr, mode));
        else
            return (cert_vendor_validate_attribute(tmpl,
                attr, mode));
    } else if (class == CKO_PUBLIC_KEY) {

        switch (subclass) {
            case CKK_RSA:
                return (rsa_publ_validate_attribute(tmpl,
                    attr, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    } else if (class == CKO_PRIVATE_KEY) {

        switch (subclass) {
            case CKK_RSA:
                return (rsa_priv_validate_attribute(tmpl,
                    attr, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    } else if (class == CKO_SECRET_KEY) {
        switch (subclass) {
            case CKK_GENERIC_SECRET:
                return (generic_secret_validate_attribute(tmpl,
                    attr, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
            }
        } else if (class == CKO_HW_FEATURE) {

        switch (subclass) {
            case CKH_CLOCK:
                return (clock_validate_attribute(tmpl,
                    attr, mode));
            case CKH_MONOTONIC_COUNTER:
                return (counter_validate_attribute(tmpl,
                    attr, mode));
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    } else if (class == CKO_DOMAIN_PARAMETERS) {
        switch (subclass) {
            default:
                return (CKR_ATTRIBUTE_VALUE_INVALID);
        }
    }
    return (CKR_ATTRIBUTE_VALUE_INVALID);
}

CK_RV
template_validate_attributes(TEMPLATE * tmpl,
    CK_ULONG   class,
    CK_ULONG   subclass,
    CK_ULONG   mode)
{
    DL_NODE *node;
    CK_RV   rc = CKR_OK;

    node = tmpl->attribute_list;

    while (node) {
        CK_ATTRIBUTE *attr = (CK_ATTRIBUTE *)node->data;

        rc = template_validate_attribute(tmpl, attr, class,
            subclass, mode);
        if (rc != CKR_OK) {
            return (rc);
        }
        node = node->next;
    }

    return (CKR_OK);
}

CK_RV
template_validate_base_attribute(TEMPLATE   * tmpl,
    CK_ATTRIBUTE  * attr,
    CK_ULONG     mode)
{
    if (! tmpl || ! attr) {
        return (CKR_FUNCTION_FAILED);
    }
    switch (attr->type) {
        case CKA_CLASS:
            if ((mode & (MODE_CREATE | MODE_DERIVE |
                MODE_KEYGEN | MODE_UNWRAP)) != 0)
                return (CKR_OK);
            break;

        case CKA_TOKEN:
            if ((mode & (MODE_CREATE | MODE_COPY |
                MODE_DERIVE | MODE_KEYGEN | MODE_UNWRAP)) != 0)
                return (CKR_OK);
            break;

        case CKA_PRIVATE:
            if ((mode & (MODE_CREATE | MODE_COPY |
                MODE_DERIVE | MODE_KEYGEN | MODE_UNWRAP)) != 0)
                return (CKR_OK);
            break;

        case CKA_LABEL:
            return (CKR_OK);
        case CKA_MODIFIABLE:
            if ((mode & (MODE_CREATE | MODE_COPY |
                MODE_DERIVE | MODE_KEYGEN | MODE_UNWRAP)) != 0)
                return (CKR_OK);
            break;

        default:
            return (CKR_TEMPLATE_INCONSISTENT);
        }

    return (CKR_ATTRIBUTE_READ_ONLY);
}