Click here to Skip to main content
15,881,898 members
Articles / Web Development / HTML

A Smart Card Framework for .NET

Rate me:
Please Sign up or sign in to vote.
4.88/5 (102 votes)
15 May 2015CPOL8 min read 2.1M   145.1K   342  
Describes a framework to use the PCSC Smart Card API with .NET.
using System;

namespace GemCard
{
	/// <summary>
	/// This interface gives access to the basic card functions. It must be implemented by a class.
	/// </summary>
	public interface	ICard
	{
		/// <summary>
		/// Wraps the PCSC funciton
		/// LONG SCardListReaders(SCARDCONTEXT hContext, 
		///		LPCTSTR mszGroups, 
		///		LPTSTR mszReaders, 
		///		LPDWORD pcchReaders 
		///	);
		/// </summary>
		/// <returns>A string array of the readers</returns>
		string[]	ListReaders();

		/// <summary>
		///  Wraps the PCSC function
		///  LONG SCardConnect(
		///		IN SCARDCONTEXT hContext,
		///		IN LPCTSTR szReader,
		///		IN DWORD dwShareMode,
		///		IN DWORD dwPreferredProtocols,
		///		OUT LPSCARDHANDLE phCard,
		///		OUT LPDWORD pdwActiveProtocol
		///	);
		/// </summary>
		/// <param name="Reader"></param>
		/// <param name="ShareMode"></param>
		/// <param name="PreferredProtocols"></param>
		void	Connect(string Reader, SHARE ShareMode, PROTOCOL PreferredProtocols);

		/// <summary>
		/// Wraps the PCSC function
		///	LONG SCardDisconnect(
		///		IN SCARDHANDLE hCard,
		///		IN DWORD dwDisposition
		///	);
		/// </summary>
		/// <param name="Disposition"></param>
		void	Disconnect(DISCONNECT Disposition);

		/// <summary>
		/// Wraps the PCSC function
		/// LONG SCardTransmit(
		///		SCARDHANDLE hCard,
		///		LPCSCARD_I0_REQUEST pioSendPci,
		///		LPCBYTE pbSendBuffer,
		///		DWORD cbSendLength,
		///		LPSCARD_IO_REQUEST pioRecvPci,
		///		LPBYTE pbRecvBuffer,
		///		LPDWORD pcbRecvLength
		///	);
		/// </summary>
		/// <param name="ApduCmd">APDUCommand object with the APDU to send to the card</param>
		/// <returns>An APDUResponse object with the response from the card</returns>
		APDUResponse	Transmit(APDUCommand ApduCmd);

        /// <summary>
        /// Wraps the PSCS function
        /// LONG SCardBeginTransaction(
        ///     SCARDHANDLE hCard
        //  );
        /// </summary>
        void BeginTransaction();

        /// <summary>
        /// Wraps the PCSC function
        /// LONG SCardEndTransaction(
        ///     SCARDHANDLE hCard,
        ///     DWORD dwDisposition
        /// );
        /// </summary>
        void EndTransaction(DISCONNECT Disposition);

        /// <summary>
        /// Gets the attributes of the card
        /// </summary>
        /// <param name="AttribId">Identifier for the Attribute to get</param>
        /// <returns>Attribute content</returns>
        byte[] GetAttribute(UInt32 AttribId);
	}

	/// <summary>
	/// SCOPE context
	/// </summary>
	public enum SCOPE
	{
		/// <summary>
		/// The context is a user context, and any database operations are performed within the
		/// domain of the user.
		/// </summary>
		User,		

		/// <summary>
		/// The context is that of the current terminal, and any database operations are performed
		/// within the domain of that terminal.  (The calling application must have appropriate
		/// access permissions for any database actions.)
		/// </summary>
		Terminal,	

		/// <summary>
		/// The context is the system context, and any database operations are performed within the
		/// domain of the system.  (The calling application must have appropriate access
		/// permissions for any database actions.)
		/// </summary>
		System	
	}

	/// <summary>
	/// SHARE mode enumeration
	/// </summary>
	public	enum SHARE
	{
		/// <summary>
		/// This application is not willing to share this card with other applications.
		/// </summary>
		Exclusive = 1,	

		/// <summary>
		/// This application is willing to share this card with other applications.
		/// </summary>
		Shared,			

		/// <summary>
		/// This application demands direct control of the reader, so it is not available to other applications.
		/// </summary>
		Direct			
	}


	/// <summary>
	/// PROTOCOL enumeration
	/// </summary>
	public	enum	PROTOCOL
	{
		/// <summary>
		/// There is no active protocol.
		/// </summary>
		Undefined	= 0x00000000,	

		/// <summary>
		/// T=0 is the active protocol.
		/// </summary>
		T0			= 0x00000001,	

		/// <summary>
		/// T=1 is the active protocol.
		/// </summary>
		T1			= 0x00000002,	

		/// <summary>
		/// Raw is the active protocol.
		/// </summary>
		Raw			= 0x00010000, 
		Default		= unchecked ((int) 0x80000000),  // Use implicit PTS.

		/// <summary>
		/// T=1 or T=0 can be the active protocol
		/// </summary>
		T0orT1		= T0 | T1
	}


	/// <summary>
	/// DISCONNECT action enumeration
	/// </summary>
	public	enum	DISCONNECT
	{
		/// <summary>
		/// Don't do anything special on close
		/// </summary>
		Leave,		

		/// <summary>
		/// Reset the card on close
		/// </summary>
		Reset,		

		/// <summary>
		/// Power down the card on close
		/// </summary>
		Unpower,	

		/// <summary>
		/// Eject(!) the card on close
		/// </summary>
		Eject	
	}
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Architect Connect In Private
Singapore Singapore
Software Architect, COM, .NET and Smartcard based security specialist.

I've been working in the software industry since I graduated in Electrical and Electronics Engineering. I chose software because I preferred digital to analog.

I started to program with 6802 machine code and evolved to the current .NET technologies... that was a long way.

For more than 20 years I have always worked in technical positions as I simply like to get my hands dirty and crack my brain when things don't go right!

After 12 years in the smart card industry I can claim a strong knowledge in security solutions based on those really small computers!
I've been back into business to design the licensing system for the enterprise solution for Consistel using a .NET smart card (yes they can run .NET CLR!)

I'm currently designing a micro-payment solution using the NXP DESFire EV1 with the ACSO6 SAM of ACS. I can then add a full proficient expertise on those systems and NFC payments.
This technology being under strict NDA by NXP I cannot publish any related article about it, however I can provide professional consulting for it.

You can contact me for professional matter by using the forum or via my LinkedIn profile.

Comments and Discussions