be_device_smartcard.h

Go to the documentation of this file.

/*
 * This software was developed at the National Institute of Standards and
 * Technology (NIST) by employees of the Federal Government in the course
 * of their official duties. Pursuant to title 17 Section 105 of the
 * United States Code, this software is not subject to copyright protection
 * and is in the public domain. NIST assumes no responsibility whatsoever for
 * its use by other parties, and makes no guarantees, expressed or implied,
 * about its quality, reliability, or any other characteristic.
 */
 
#ifndef __BE_DEVICE_SMARTCARD_H__
#define __BE_DEVICE_SMARTCARD_H__
 
#include <cstdint>
#include <memory>
#include <string>
#include <be_memory_autoarray.h>
 
namespace BiometricEvaluation 
{
        namespace Device
        {
                class Smartcard {
                public:
                        class APDU;     /* Represents an APDU sent to a card */
 
                        struct APDUResponse {
                                uint8_t sw1{0};
 
                                uint8_t sw2{0};
 
                                Memory::uint8Array data;
 
                                APDUResponse() = default;
 
                                APDUResponse(
                                    const Memory::uint8Array &data,
                                    const uint8_t sw1,
                                    const uint8_t sw2);
 
                                ~APDUResponse() = default;
                        };
 
                        struct APDUException {
                                APDUResponse response;
 
                                Memory::uint8Array apdu;
 
                                APDUException() = default;
 
                                APDUException(
                                    const APDUResponse &response,
                                    const Memory::uint8Array &apdu);
                        };
 
                        Smartcard(
                            unsigned int cardNum);
 
                        Smartcard(
                            unsigned int cardNum,
                            const Memory::uint8Array &appID);
 
                        Memory::uint8Array getDedicatedFileObject(
                            const Memory::uint8Array &objectID);
 
                        APDUResponse sendAPDU(
                            Device::Smartcard::APDU &apdu);
 
                        Memory::uint8Array getLastAPDU() const;
 
                        Memory::uint8Array getLastResponseData() const;
 
                        std::string getReaderID() const;
 
                        void setDryrun(bool state);
 
                        /*
                         * We cannot use the default destructor here due to the
                         * Impl smart pointer contained within this object.
                         */
                        ~Smartcard();
 
                         Smartcard(Smartcard&& other) noexcept;
 
                         Smartcard& operator=(Smartcard&& other) noexcept;
                private:
                        class Impl;
                        std::unique_ptr<Smartcard::Impl> pimpl;
                };
        }
}
#endif /* __BE_DEVICE_SMARTCARD_H__ */