public void _01_BasicGetInfoTest()
{
if (Platform.UnmanagedLongSize != 8 || Platform.StructPackingSize != 1)
Assert.Inconclusive("Test cannot be executed on this platform");
CKR rv = CKR.CKR_OK;
using (Pkcs11 pkcs11 = new Pkcs11(Settings.Pkcs11LibraryPath))
{
rv = pkcs11.C_Initialize(Settings.InitArgs81);
if ((rv != CKR.CKR_OK) && (rv != CKR.CKR_CRYPTOKI_ALREADY_INITIALIZED))
Assert.Fail(rv.ToString());
CK_INFO info = new CK_INFO();
rv = pkcs11.C_GetInfo(ref info);
if (rv != CKR.CKR_OK)
Assert.Fail(rv.ToString());
// Do something interesting with library information
Assert.IsFalse(String.IsNullOrEmpty(ConvertUtils.BytesToUtf8String(info.ManufacturerId)));
rv = pkcs11.C_Finalize(IntPtr.Zero);
if (rv != CKR.CKR_OK)
Assert.Fail(rv.ToString());
}
}
/// <summary>
/// Checks whether PKCS#11 library information matches PKCS#11 URI
/// </summary>
/// <param name="pkcs11Uri">PKCS#11 URI</param>
/// <param name="libraryInfo">PKCS#11 library information</param>
/// <returns>True if PKCS#11 library information matches PKCS#11 URI</returns>
public static bool Matches(Pkcs11Uri pkcs11Uri, CK_INFO libraryInfo)
{
if (pkcs11Uri == null)
throw new ArgumentNullException("pkcs11Uri");
string manufacturer = ConvertUtils.BytesToUtf8String(libraryInfo.ManufacturerId, true);
string description = ConvertUtils.BytesToUtf8String(libraryInfo.LibraryDescription, true);
string version = libraryInfo.LibraryVersion.ToString();
return Pkcs11UriSharedUtils.Matches(pkcs11Uri, manufacturer, description, version);
}
/// <summary>
/// Obtains a list of all slots where token that matches PKCS#11 URI is present
/// </summary>
/// <param name="pkcs11Uri">PKCS#11 URI</param>
/// <param name="pkcs11Library">Low level PKCS#11 wrapper</param>
/// <param name="tokenPresent">Flag indicating whether the list obtained includes only those slots with a token present (true), or all slots (false)</param>
/// <param name="slotList">List of slots matching PKCS#11 URI</param>
/// <returns>CKR_OK if successful; any other value otherwise</returns>
public static CKR GetMatchingSlotList(Pkcs11Uri pkcs11Uri, Pkcs11Library pkcs11Library, bool tokenPresent, out NativeULong[] slotList)
{
if (pkcs11Uri == null)
{
throw new ArgumentNullException("pkcs11Uri");
}
if (pkcs11Library == null)
{
throw new ArgumentNullException("pkcs11Library");
}
List <NativeULong> matchingSlots = new List <NativeULong>();
// Get library information
CK_INFO libraryInfo = new CK_INFO();
CKR rv = pkcs11Library.C_GetInfo(ref libraryInfo);
if (rv != CKR.CKR_OK)
{
slotList = new NativeULong[0];
return(rv);
}
// Check whether library matches URI
if (!Matches(pkcs11Uri, libraryInfo))
{
slotList = new NativeULong[0];
return(CKR.CKR_OK);
}
// Get number of slots in first call
NativeULong slotCount = 0;
rv = pkcs11Library.C_GetSlotList(false, null, ref slotCount);
if (rv != CKR.CKR_OK)
{
slotList = new NativeULong[0];
return(rv);
}
if (slotCount < 1)
{
slotList = new NativeULong[0];
return(CKR.CKR_OK);
}
// Allocate array for slot IDs
NativeULong[] slots = new NativeULong[slotCount];
// Get slot IDs in second call
rv = pkcs11Library.C_GetSlotList(tokenPresent, slots, ref slotCount);
if (rv != CKR.CKR_OK)
{
slotList = new NativeULong[0];
return(rv);
}
// Shrink array if needed
if (slots.Length != ConvertUtils.UInt64ToInt32(slotCount))
{
Array.Resize(ref slots, ConvertUtils.UInt64ToInt32(slotCount));
}
// Match slots with Pkcs11Uri
foreach (NativeULong slot in slots)
{
CK_SLOT_INFO slotInfo = new CK_SLOT_INFO();
rv = pkcs11Library.C_GetSlotInfo(slot, ref slotInfo);
if (rv != CKR.CKR_OK)
{
slotList = new NativeULong[0];
return(rv);
}
// Check whether slot matches URI
if (Matches(pkcs11Uri, slotInfo, slot))
{
if ((slotInfo.Flags & CKF.CKF_TOKEN_PRESENT) == CKF.CKF_TOKEN_PRESENT)
{
CK_TOKEN_INFO tokenInfo = new CK_TOKEN_INFO();
rv = pkcs11Library.C_GetTokenInfo(slot, ref tokenInfo);
if (rv != CKR.CKR_OK)
{
slotList = new NativeULong[0];
return(rv);
}
// Check whether token matches URI
if (Matches(pkcs11Uri, tokenInfo))
{
matchingSlots.Add(slot);
}
}
else
{
if (!tokenPresent && Pkcs11UriSharedUtils.Matches(pkcs11Uri, null, null, null, null))
{
matchingSlots.Add(slot);
}
}
}
}
slotList = matchingSlots.ToArray();
return(CKR.CKR_OK);
}
/// <summary>
/// Gets general information about loaded PKCS#11 library
/// </summary>
/// <returns>General information about loaded PKCS#11 library</returns>
public LibraryInfo GetInfo()
{
if (this._disposed)
throw new ObjectDisposedException(this.GetType().FullName);
CK_INFO info = new CK_INFO();
CKR rv = _p11.C_GetInfo(ref info);
if (rv != CKR.CKR_OK)
throw new Pkcs11Exception("C_GetInfo", rv);
return new LibraryInfo(info);
}
/// <summary>
/// Returns general information about Cryptoki
/// </summary>
/// <param name="info">Structure that receives the information</param>
/// <returns>CKR_ARGUMENTS_BAD, CKR_CRYPTOKI_NOT_INITIALIZED, CKR_FUNCTION_FAILED, CKR_GENERAL_ERROR, CKR_HOST_MEMORY, CKR_OK</returns>
public CKR C_GetInfo(ref CK_INFO info)
{
if (this._disposed)
throw new ObjectDisposedException(this.GetType().FullName);
ulong rv = _delegates.C_GetInfo(ref info);
return (CKR)Convert.ToUInt32(rv);
}
internal static extern ulong C_GetInfo(ref CK_INFO info);
/// <summary>
/// Returns general information about Cryptoki
/// </summary>
/// <param name="info">Structure that receives the information</param>
/// <returns>CKR_ARGUMENTS_BAD, CKR_CRYPTOKI_NOT_INITIALIZED, CKR_FUNCTION_FAILED, CKR_GENERAL_ERROR, CKR_HOST_MEMORY, CKR_OK</returns>
public CKR C_GetInfo(ref CK_INFO info)
{
if (this._disposed)
throw new ObjectDisposedException(this.GetType().FullName);
return _delegates.C_GetInfo(ref info);
}
public void _02_LibraryInfoMatches()
{
if (Platform.UnmanagedLongSize != 8 || Platform.StructPackingSize != 1)
Assert.Inconclusive("Test cannot be executed on this platform");
// Empty URI
Pkcs11Uri pkcs11uri = new Pkcs11Uri(@"pkcs11:");
CK_INFO libraryInfo = new CK_INFO();
libraryInfo.ManufacturerId = ConvertUtils.Utf8StringToBytes("foo");
libraryInfo.LibraryDescription = ConvertUtils.Utf8StringToBytes("bar");
libraryInfo.LibraryVersion = new CK_VERSION() { Major = new byte[] { 0x01 }, Minor = new byte[] { 0x00 } };
Assert.IsTrue(Pkcs11UriUtils.Matches(pkcs11uri, libraryInfo));
// Empty attribute
pkcs11uri = new Pkcs11Uri(@"pkcs11:library-manufacturer=;library-description=bar;library-version=1");
libraryInfo = new CK_INFO();
libraryInfo.ManufacturerId = ConvertUtils.Utf8StringToBytes(" ");
libraryInfo.LibraryDescription = ConvertUtils.Utf8StringToBytes("bar");
libraryInfo.LibraryVersion = new CK_VERSION() { Major = new byte[] { 0x01 }, Minor = new byte[] { 0x00 } };
Assert.IsTrue(Pkcs11UriUtils.Matches(pkcs11uri, libraryInfo));
// Unknown path attribute in URI
pkcs11uri = new Pkcs11Uri(@"pkcs11:library-manufacturer=foo;library-description=bar;library-version=1;foo=bar");
libraryInfo = new CK_INFO();
libraryInfo.ManufacturerId = ConvertUtils.Utf8StringToBytes("foo");
libraryInfo.LibraryDescription = ConvertUtils.Utf8StringToBytes("bar");
libraryInfo.LibraryVersion = new CK_VERSION() { Major = new byte[] { 0x01 }, Minor = new byte[] { 0x00 } };
Assert.IsFalse(Pkcs11UriUtils.Matches(pkcs11uri, libraryInfo));
// All attributes matching
pkcs11uri = new Pkcs11Uri(@"pkcs11:library-manufacturer=foo;library-description=bar;library-version=1");
libraryInfo = new CK_INFO();
libraryInfo.ManufacturerId = ConvertUtils.Utf8StringToBytes("foo");
libraryInfo.LibraryDescription = ConvertUtils.Utf8StringToBytes("bar");
libraryInfo.LibraryVersion = new CK_VERSION() { Major = new byte[] { 0x01 }, Minor = new byte[] { 0x00 } };
Assert.IsTrue(Pkcs11UriUtils.Matches(pkcs11uri, libraryInfo));
// LibraryManufacturer nonmatching
pkcs11uri = new Pkcs11Uri(@"pkcs11:library-manufacturer=foo;library-description=bar;library-version=1");
libraryInfo = new CK_INFO();
libraryInfo.ManufacturerId = ConvertUtils.Utf8StringToBytes("bar");
libraryInfo.LibraryDescription = ConvertUtils.Utf8StringToBytes("bar");
libraryInfo.LibraryVersion = new CK_VERSION() { Major = new byte[] { 0x01 }, Minor = new byte[] { 0x00 } };
Assert.IsFalse(Pkcs11UriUtils.Matches(pkcs11uri, libraryInfo));
// LibraryDescription nonmatching
pkcs11uri = new Pkcs11Uri(@"pkcs11:library-manufacturer=foo;library-description=bar;library-version=1");
libraryInfo = new CK_INFO();
libraryInfo.ManufacturerId = ConvertUtils.Utf8StringToBytes("foo");
libraryInfo.LibraryDescription = ConvertUtils.Utf8StringToBytes("foo");
libraryInfo.LibraryVersion = new CK_VERSION() { Major = new byte[] { 0x01 }, Minor = new byte[] { 0x00 } };
Assert.IsFalse(Pkcs11UriUtils.Matches(pkcs11uri, libraryInfo));
// LibraryVersion nonmatching
pkcs11uri = new Pkcs11Uri(@"pkcs11:library-manufacturer=foo;library-description=bar;library-version=1");
libraryInfo = new CK_INFO();
libraryInfo.ManufacturerId = ConvertUtils.Utf8StringToBytes("foo");
libraryInfo.LibraryDescription = ConvertUtils.Utf8StringToBytes("bar");
libraryInfo.LibraryVersion = new CK_VERSION() { Major = new byte[] { 0x00 }, Minor = new byte[] { 0x01 } };
Assert.IsFalse(Pkcs11UriUtils.Matches(pkcs11uri, libraryInfo));
}
public void _06_GetMatchingSlotList()
{
if (Platform.UnmanagedLongSize != 8 || Platform.StructPackingSize != 1)
Assert.Inconclusive("Test cannot be executed on this platform");
using (Pkcs11 pkcs11 = new Pkcs11(Settings.Pkcs11LibraryPath, Settings.UseOsLocking))
{
CKR rv = pkcs11.C_Initialize(Settings.InitArgs81);
Assert.IsTrue(rv == CKR.CKR_OK);
// Get all slots
ulong allSlotsCount = 0;
rv = pkcs11.C_GetSlotList(true, null, ref allSlotsCount);
Assert.IsTrue(rv == CKR.CKR_OK);
Assert.IsTrue(allSlotsCount > 0);
ulong[] allSlots = new ulong[allSlotsCount];
rv = pkcs11.C_GetSlotList(true, allSlots, ref allSlotsCount);
Assert.IsTrue(rv == CKR.CKR_OK);
// Empty URI
Pkcs11Uri pkcs11uri = new Pkcs11Uri(@"pkcs11:");
ulong[] matchedSlots = null;
rv = Pkcs11UriUtils.GetMatchingSlotList(pkcs11uri, pkcs11, true, out matchedSlots);
Assert.IsTrue(rv == CKR.CKR_OK);
Assert.IsTrue(matchedSlots.Length == allSlots.Length);
// Unknown path attribute in URI
pkcs11uri = new Pkcs11Uri(@"pkcs11:vendor=foobar");
rv = Pkcs11UriUtils.GetMatchingSlotList(pkcs11uri, pkcs11, true, out matchedSlots);
Assert.IsTrue(rv == CKR.CKR_OK);
Assert.IsTrue(matchedSlots.Length == 0);
// All attributes matching one slot
CK_INFO libraryInfo = new CK_INFO();
rv = pkcs11.C_GetInfo(ref libraryInfo);
Assert.IsTrue(rv == CKR.CKR_OK);
CK_SLOT_INFO slotInfo = new CK_SLOT_INFO();
rv = pkcs11.C_GetSlotInfo(allSlots[0], ref slotInfo);
Assert.IsTrue(rv == CKR.CKR_OK);
CK_TOKEN_INFO tokenInfo = new CK_TOKEN_INFO();
rv = pkcs11.C_GetTokenInfo(allSlots[0], ref tokenInfo);
Assert.IsTrue(rv == CKR.CKR_OK);
Pkcs11UriBuilder pkcs11UriBuilder = new Pkcs11UriBuilder();
pkcs11UriBuilder.LibraryManufacturer = ConvertUtils.BytesToUtf8String(libraryInfo.ManufacturerId, true);
pkcs11UriBuilder.LibraryDescription = ConvertUtils.BytesToUtf8String(libraryInfo.LibraryDescription, true);
pkcs11UriBuilder.LibraryVersion = libraryInfo.LibraryVersion.ToString();
pkcs11UriBuilder.SlotManufacturer = ConvertUtils.BytesToUtf8String(slotInfo.ManufacturerId, true);
pkcs11UriBuilder.SlotDescription = ConvertUtils.BytesToUtf8String(slotInfo.SlotDescription, true);
pkcs11UriBuilder.SlotId = allSlots[0];
pkcs11UriBuilder.Token = ConvertUtils.BytesToUtf8String(tokenInfo.Label, true);
pkcs11UriBuilder.Manufacturer = ConvertUtils.BytesToUtf8String(tokenInfo.ManufacturerId, true);
pkcs11UriBuilder.Serial = ConvertUtils.BytesToUtf8String(tokenInfo.SerialNumber, true);
pkcs11UriBuilder.Model = ConvertUtils.BytesToUtf8String(tokenInfo.Model, true);
pkcs11uri = pkcs11UriBuilder.ToPkcs11Uri();
rv = Pkcs11UriUtils.GetMatchingSlotList(pkcs11uri, pkcs11, true, out matchedSlots);
Assert.IsTrue(rv == CKR.CKR_OK);
Assert.IsTrue(matchedSlots.Length == 1);
// One attribute nonmatching
pkcs11UriBuilder.Serial = "foobar";
pkcs11uri = pkcs11UriBuilder.ToPkcs11Uri();
rv = Pkcs11UriUtils.GetMatchingSlotList(pkcs11uri, pkcs11, true, out matchedSlots);
Assert.IsTrue(rv == CKR.CKR_OK);
Assert.IsTrue(matchedSlots.Length == 0);
rv = pkcs11.C_Finalize(IntPtr.Zero);
Assert.IsTrue(rv == CKR.CKR_OK);
}
}
/// <summary>
/// Obtains a list of all slots where token that matches PKCS#11 URI is present
/// </summary>
/// <param name="pkcs11Uri">PKCS#11 URI</param>
/// <param name="pkcs11">Low level PKCS#11 wrapper</param>
/// <param name="tokenPresent">Flag indicating whether the list obtained includes only those slots with a token present (true), or all slots (false)</param>
/// <param name="slotList">List of slots matching PKCS#11 URI</param>
/// <returns>CKR_OK if successful; any other value otherwise</returns>
public static CKR GetMatchingSlotList(Pkcs11Uri pkcs11Uri, Pkcs11 pkcs11, bool tokenPresent, out ulong[] slotList)
{
if (pkcs11Uri == null)
throw new ArgumentNullException("pkcs11Uri");
if (pkcs11 == null)
throw new ArgumentNullException("pkcs11");
List<ulong> matchingSlots = new List<ulong>();
// Get library information
CK_INFO libraryInfo = new CK_INFO();
CKR rv = pkcs11.C_GetInfo(ref libraryInfo);
if (rv != CKR.CKR_OK)
{
slotList = new ulong[0];
return rv;
}
// Check whether library matches URI
if (!Matches(pkcs11Uri, libraryInfo))
{
slotList = new ulong[0];
return CKR.CKR_OK;
}
// Get number of slots in first call
ulong slotCount = 0;
rv = pkcs11.C_GetSlotList(false, null, ref slotCount);
if (rv != CKR.CKR_OK)
{
slotList = new ulong[0];
return rv;
}
if (slotCount < 1)
{
slotList = new ulong[0];
return CKR.CKR_OK;
}
// Allocate array for slot IDs
ulong[] slots = new ulong[slotCount];
// Get slot IDs in second call
rv = pkcs11.C_GetSlotList(tokenPresent, slots, ref slotCount);
if (rv != CKR.CKR_OK)
{
slotList = new ulong[0];
return rv;
}
// Shrink array if needed
if (slots.Length != Convert.ToInt32(slotCount))
Array.Resize(ref slots, Convert.ToInt32(slotCount));
// Match slots with Pkcs11Uri
foreach (ulong slot in slots)
{
CK_SLOT_INFO slotInfo = new CK_SLOT_INFO();
rv = pkcs11.C_GetSlotInfo(slot, ref slotInfo);
if (rv != CKR.CKR_OK)
{
slotList = new ulong[0];
return rv;
}
// Check whether slot matches URI
if (Matches(pkcs11Uri, slotInfo, slot))
{
if ((slotInfo.Flags & CKF.CKF_TOKEN_PRESENT) == CKF.CKF_TOKEN_PRESENT)
{
CK_TOKEN_INFO tokenInfo = new CK_TOKEN_INFO();
rv = pkcs11.C_GetTokenInfo(slot, ref tokenInfo);
if (rv != CKR.CKR_OK)
{
slotList = new ulong[0];
return rv;
}
// Check whether token matches URI
if (Matches(pkcs11Uri, tokenInfo))
matchingSlots.Add(slot);
}
else
{
if (!tokenPresent && Pkcs11UriSharedUtils.Matches(pkcs11Uri, null, null, null, null))
matchingSlots.Add(slot);
}
}
}
slotList = matchingSlots.ToArray();
return CKR.CKR_OK;
}
internal static extern NativeULong C_GetInfo(ref CK_INFO info);
/// <summary>
/// Converts low level CK_INFO structure to high level LibraryInfo class
/// </summary>
/// <param name="ck_info">Low level CK_INFO structure</param>
internal LibraryInfo(CK_INFO ck_info)
{
_cryptokiVersion = ck_info.CryptokiVersion.ToString();
_manufacturerId = ConvertUtils.BytesToUtf8String(ck_info.ManufacturerId, true);
_flags = ck_info.Flags;
_libraryDescription = ConvertUtils.BytesToUtf8String(ck_info.LibraryDescription, true);
_libraryVersion = ck_info.LibraryVersion.ToString();
}
internal static extern CKR C_GetInfo(ref CK_INFO info);
internal static extern ulong C_GetInfo(ref CK_INFO info);