Package: cryptnoxpro
Cryptnox ProWarning: This is a beta release of the software.
It is released for development purposes.
Use at your own risk.A command line user interface to manage and use ofCryptnox Smart cards.This provides basic wallets forBitcoinandEthereum.It is able to executecleoscommands and use
the keys on the card for signing.To buy NFC enabled cards that are supported by this application go to:https://www.cryptnox.com/LicenseThe library is available under dual licensing. You can use the library under the
conditions ofGNU GENERAL PUBLIC LICENSE 3.0+orcontact usto ask about commercial licensing.Installation and requirementsThe package can be installed using pip package manager with:pipinstallcryptnoxproThe application can also be installed from source as python package.
In the root of the project, execute:pipinstall.This installs the application into your python packages and makes thecrytpnoxavailable as executable.If during python installation its path was added to system path the executable,
e.g. command is available system wide.Windows Microsoft Visual C++ 14.x build toolsIf you wish to install from pip package on windows, because of dependencies you will
have to install Microsoft Visual C++ 14.x build tools that you can download from here:https://visualstudio.microsoft.com/visual-cpp-build-tools/Linux additional packagesOn some Debian/Ubuntu Linux systems there binaries for sme libraries are not
delivered with the installed package. In this case install the following tools,
so that they can be compiled during installation process.Ubuntu / Debiansudoapt-getinstallbuild-essentialautoconflibtoolpkg-configpython3-devswiglibpcsclite-devpipinstall-UsetuptoolsFedora / CentOS / RHELyuminstallswigpython3-pippython3-setuptoolspcsc-lite-ccidpipinstall-UsetuptoolsMacOS additional packagesOn MacOS to install CryptnoxPro with pip you need to add swig to the system as there are some
dependencies written in C/C++brewinstallswigMacOS missing certificatesIf you’re using macOS and the command CLI is showing issues of missing certificates,
open Macintosh HD > Applications > Python3.6 folder (or other version of python you’re using) >
double click onInstall Certificates.commandfile.Running the applicationThe application can receive commands directly in any command line, or can be started inInteractive Modeby starting without any arguments or options.
The later will also start if the executable is called from a GUI, like Windows Explorer.Remote modeWhile running the application without arguments starts a local mode, a port number can be provided
as argument to start remote mode. This enables the application to connect to an interface on the
same machine via the provided port.An example below:cryptnox--port1234Note: An interface to relay commands to remote reader should be developed in advance to accept this connection.Exit inputWhenever an input is requested from the user: PIN or PUK code or any other information,
the command execution can be exited with the keywordexit. When this is used the
command stops the execution.To not overcrowd the interface this is not mentioned when information is requested by
the CLI.Exiting the CLI closes existing card interface connections for remote mode.Development environmentFor development purposes or for running separately from the system environment
pipenv configuration files are provided.To set it up, use, from the root folder of the project:pipenvinstallor, if you want libraries for development purposes like pylint:pipenvinstall--devTo enter the new environment use:pipenvshellThis will open a new terminal inside the one it was called from. From here all
packages will be available to run the application.From here the CLI is available as a script:pythoncryptnoxpro/main.pyor as a module:python-mcryptnoxpro.mainSecretsEach card is protected by two secrets only known to the owner of the card.PIN codeThe PIN code must be 4 to 9 number characters (‘0’-‘9’).
After entering the wrong PIN code 3 times the card PIN code is
locked, and it must be unlocked using the PUK code.Entering the correct PIN code resets the number of times the wrong PIN code
can be entered.PUK codeThe PUK code must be 15 alphanumerical characters (‘a’-‘z’, ‘A’-‘Z’, ‘0’-‘9’).Easy modeWarning:Only use for testing purposes.The card can be initialized in easy mode. This is done for convenience of the
user as you don’t have to enter the card secrets. For this reason it comes at
the expense of security.The card is initialized with following infomation:Owner name: “EASY MODE”Owner email: “EASY MODE”PIN code 000000000PIK code 000000000000 (the length depends on te card type)When the application asks for any secret, PIN or PUK code, press “ENTER” key.
The application will use the predefined information to fill it for you.Easy mode on card is determined from the owner name and email.Interactive modeAn interactive mode is available if the command is entered without any arguments
and options.In this mode the user will get a similar interface as a command line with its
own prompt accepting same commands as regular call.When the mode starts it will show list of available cards.The prompt is also showing useful information:cryptnoxproindicates that the user is in interactive modeSerial number of the selected card on which the command will be executedIndication that the card is in easy modeSeed generationThere are several ways to populate a card with a seed.Those that need entropy use the random number generator on the card.BackupTo use this way of creating a seed access toAWSis required.
It is out of the scope of this documentation how to acquireAccess Key IDandSecret Access Keyfrom the AWS as it’s a third party service and may change.After getting the entropy from the card the user is asked for AWS access keys, two regions and a
name for the backup. Two regions are used for using KMS and Secrets Manager services on two
separate machines to increase the security of the saved entropy. Name of the backup is used to
identify which entropy will be restored with the Restore command.The backed up information is retrieved for comparison with the original to make sure the saving
process was successful and next time when the data is retrieved is the same as the entropy that is
us for seed generation for the card. After this the seed is uploaded to the card.After the operation a summary will be shown and saved to a file with the name of the regions and
name of the backup.This is safe way to store the entropy as the information for recreating is saved in the cloud in
two separate regions chosen by the user. It is also simpler then requesting from the user to secure
the mnemonic.Dual InitializationFor this process two Cryptnox Cards are required. The seed is generated in both cards in a secure
way. You will need to start the command with the first card for the host to get information from it.
After that the user is asked to remove the card and insert the second card into the same reader.
The information from the first card will be injected into the second card and a seed is generated
in the second card at this point. The process is not finished. Information will be requested
from second card and the user needs to remove the second card and insert the first card into
the same reader. The information from the second card will be injected into the first card. At
this time the first card will use the information to generate the same seed the second card has
already generated. When the process has finished the two card will have the same seed in them
and have access to the same accounts.This is the most secure way to generate a seed while still having a backup. The seed newer leaves
the card. The common information is used for it’s generation, but the information that was received
from the card in the process is not enough to generate the seed.RecoverCreate seed from the mnemonic,BIP39,
entered by the user and upload it onto the card. This mnemonic could be acquired by using the
command Upload.RestoreTo use this way of creating a seed access toAWSis required.
It is out of the scope of this documentation how to acquireAccess Key IDandSecret Access Keyfrom the AWS as it’s a third party service and may change.If a Backup operation has been finished this command allows for retrieval of the entropy and it’s
usage in populating a card with a seed. The user will be asked for AWS access keys, two regions
and the name of the backup to be retrieved. The host tries to acquire the backup from the two given
regions under the given name. The retrieved information is used to generate a seed that is uploaded
to the card.UploadGet the entropy from the card. Generate mnemonicBIP39and seed on the host.
Upload the seed to the card. Show the mnemonic to the user for saving it, on a paper or electronic
form for later recovery.With the mnemonic the seed can be generated by anyone and access to funds connected to accounts
gained. It is the responsibility of the user to keep the mnemonic safe and secure.If the mnemonic is lost there is no way to recover the account and funds connected to it.ChangelogAll notable changes to this project will be documented in this file.The format is based onKeep a Changelog,
and this project adheres toSemantic Versioning.Unreleased2.8.0- 2022-01-31AddedOption to start a server and access the card remotely2.7.0- 2022-11-28AddedCard can be opened with AWS KMS key instead of PIN codeOption to backup to cloud when seed is uploaded or recovered2.6.0- 2022-09-30AddedERC1155 contract ABI to system for selection for useFixedeosiocommandgetsubcommand help not shown2.5.0- 2022-08-11AddedDefault servers for AWS backup and restoreDefault randomized alias for AWS backupUserootkey.csvfile from download folder for AWS backup and restore, delete credentials after operationChangedIn case of exception write the error log into user folder instead of installation folderFixedMissing word for retrying PIN codeSeed phrase of length other than 12 or 24 words is accepted by the system2.4.0- 2022-07-19AddedPython 3.10 supportFor NFT cards abi url parsingRemovedPython 3.6 supportFixedApplication crashing when using current key with derivation path2.3.0- 2022-06-07AddedRemote mode for connecting over a portChangedInstallation instructions added missing instructions2.2.2- 2022-03-17FixedInit not finished with NFT card when ABI is large2.2.1- 2022-03-14FixedApplication crashes when initializing NFT cardHelp not show on some commandsList of cards is doubled when executing list commandSeed backup to KMS name of backup error message not clear enoughCard not reloaded after dual seed generationApplication crashes during dual seed generation while waiting for second card2.2.0- 2022-01-31ChangedCombined two scripts into oneDemo mode renamed to easy modeApplication name changed to Cryptnox ProFixedError handling while waiting for card when timeout is exceededError handling when a user enters value for mnemonic that is invalid for BIP39Input for user key description to allow numbers and lettersCrash when showing seed backup options for AWS server2.1.0- 2022-01-04AddedSeparate CLI for working with NFT cardseht command contract parameter to send ERC20 tokensFixedException handling in multiple places.2.0.0- 2021-10-13AddedDynamic fee calculation for Bitcoin and Ethereum networksChangedRecovering seed from mnemonic compliant with BIP39Derivation paths to be compliant with BIP44FixedSend/transfer memo for EOSIOSigning multi-input transaction for BTC with user keyPrecision of amounts for sendingAWS backup wrong credentials crash the applicationverbose option is not doing anythingEOS transfer doesn’t use sender but behaves as send command1.3.2- 2021-10-13ChangedEthereum endpoint through cryptnox node updated to use different domains on standard portsWithinfocommand for balance show the issue instead of “–”Fixedexitkeyword when input is requested from user, like PIN or PUK codeBitcoin sending with multiple inputs is rejected by the node1.3.1- 2021-10-07FixedCrash when calling config under currencies1.3.0- 2021-10-06Addedcard_config can update the status of PIN-less path and PIN authentication.ChangedConfiguration is saved into the card instead of a file.FixedWhen waiting for card after card is detected the application crashes.Ethereum network name conversion1.2.0- 2021-09-16AddedNew endpoint for Ethereum network used by default. User can still the infura network with a project keyChangedOrdering in config command to BTC, ETH, EOS.When changing PIN or PUK code message made clear that the card is not initialized.Resetting uninitialized card message updated.User key check if card is initialized before continuing.In change_puk check current PUK before asking for new one.Show warning on command if card origin is unknown or fake instead of exiting command.FixedIn demo mode when asked for PUK code, entering anything will go into loop asking for the code.There is no message when adding piv, but piv is not present1.1.0- 2021-09-16AddedBackup and restore of entropy for seed generation to KMS in HSM.1.0.2- 2021-09-09ChangedImprove setup process.1.0.1- 2021-08-20FixedUpdate package on PiPI.1.0.0- 2021-08-20AddedCommand line interface with commands for interacting with Cryptnox cards.Interactive mode.Pipfile and requirements for setting up environment.Setup file to install the library.