arpa2 / keehive

Remote PKCS #11 Client Library and Hosting Dæmon (comms uses ASN.1 spec over Kerberos-protected links)

Introduction

Please not that this project is still very much in early development and is probably not building for you.

I suggest you come back in a little while :)

• http://www.arpa2.net/
• https://github.com/arpa2/multi-pkcs11

Dependencies

• Cmake
• https://github.com/vanrein/quick-der
• https://github.com/arpa2/arpa2cm

For testing:

• https://cmocka.org/
• https://github.com/opendnssec/SoftHSMv2
• cpp unit

On Debian/Ubuntu these are available as packages:

$ sudo apt install libsofthsm2-dev libcmocka-dev libcppunit-dev

Build

 $ mkdir build
 $ cd build
 $ cmake ..
 $ make
 $ make install

Testing

 $ mkdir build
 $ cd build
 $ cmake .. -DENABLE_TESTING=ON
 $ make
 $ make test

Development

To generate the source code from the ASN1 definition:

• Install python3
• $ pip install -r generate/requirements.txt
• $ python3 generate/generate.py

keehive's Issues

parsing ck_initialize_args broken

work in progress

problem linking to softhsm on os x

opendnssec/SoftHSMv2#355

Impossible to figure out length of pSeed in pack_C_GenerateRandom_Return

Everywhere in the API and spec the arrays passed around are bundled with a length variable, with one exception: pSeed in pack_C_GenerateRandom_Return.

keehive/src/generated/pack.c

Line 3538 in 4b247ba

pulSeedLen,

For now this is a hardcoded value (0).

@vanrein proposed to wrap every object into a dercursor. I think this is a bit overkill, since this is the only point that I know of where this is a problem. i propose we change the spec.

Enable travis

travis config file + docker build files are already in the tree.

https://travis-ci.org/arpa2/

Softhsm2 test suite calls some functions with NULL argument, ans1 spec doesn't support this

C_DigestInit()
https://github.com/arpa2/keehive/blob/master/src/static/test/softhsm2/DigestTests.cpp#L60

C_DigestUpdate()
https://github.com/arpa2/keehive/blob/master/src/static/test/softhsm2/DigestTests.cpp#L162

C_DigestFinal()
https://github.com/arpa2/keehive/blob/master/src/static/test/softhsm2/DigestTests.cpp#L241

C_GetSlotList()
https://github.com/arpa2/keehive/blob/master/src/static/test/softhsm2/InfoTests.cpp#L91

Memory management needs improvement

various mallocs here and there, without free. Most of them are tagged with a todo comment though

wrong type for phObject in C-FindObjects-Return

I think this should be ACK-OBJECT-HANDLE

https://github.com/arpa2/keehive/blob/master/data/RemotePKCS11.asn1#L688

Administration of call back functions is missing

C_VerifyRecoverInit mssing in ASN1 definition

is defined in the standard

http://docs.oasis-open.org/pkcs11/pkcs11-base/v2.40/os/pkcs11-base-v2.40-os.html

but missing in the ASN1 definition. Call and Return for C-VerifyRecover are defined though.

malloc in derput.c gives Signal: SIGSEGV (Segmentation fault)

this malloc gives a sigsegv
https://github.com/arpa2/keehive/blob/master/src/static/derput.c#L151

when called by softhsm2 test suite from

https://github.com/arpa2/keehive/blob/master/src/static/test/softhsm2/ObjectTests.cpp#L890

der_putget_CK_BYTE_ARRAY in src/static/test/test_derputget.c fails

This test just does a pack and unpack roundtrip for a CK_BYTE_ARRAY. Somehow the even characters are missing. (input: "abcdefghijklm" output "acegikm").

test_pack_C_OpenSession_Call in keehive/src/generated/test/test_pack.c fails

the first der_unpack() call inside unpack_C_OpenSession_Call() on the packed structure fails. I don't understand what is wrong, as far as I know, I set & pack all the fields correctly.

unpacking CK_ATTRIBUTE_ARRAY for C_GetAttributeValue_Call fails

unpacking CK_ATTRIBUTE_ARRAY fails at:

keehive/src/static/derget.c

Line 63 in 5df9065

return status;

called by C_GetAttributeValue_Call:

keehive/src/generated/api.c

Line 1659 in 5df9065

status = pack_C_GetAttributeValue_Call(

).

Cursor is packed at:

keehive/src/generated/pack.c

Line 3594 in 5df9065

CK_RV pTemplate_status = der_put_CK_ATTRIBUTE_ARRAY(

I can't figure out why this fails, since it works in all other cases and all other tests.