SecuTech Wiki - User contributions [en]

Seed portal

2019-12-12T04:38:18Z

Administrator:

[[Category:UniOTP_Tools]]

==Seed Portal and Token Troubleshooting Guide==
Guide Version: 1.0
==Introduction==
The UniOTP Seed portal located here: https://esecutech.com/seed_portal/index.php is used to download, convert and troubleshoot OTP secret key files and tokens.

English and Chinese language option in the top left.

[[File:seedportal.png|400px|thumb|center|UniOTP seed portal, "Choose File" operation does not upload the secret key files anywhere, it only loads them onto the browser of the local machine.]]
The features are:
*[[#Download_tokens| Download tokens]]
*[[#Load_tokens| Load tokens]]
*[[#Convert_tokens| Convert seedfile format]]
*[[#Synchronize_tokens| Synchronize seed file to token]]
*[[#Search_tokens| Search for lost serial number of a token]]
*[[#troubleshoot_tokens| Troubleshooting OTPs]]
<div id="Download_tokens">
== Download tokens from SecuTech ==
When a new token has been purchased from SecuTech, a link is provided, eg. https://esecutech.com/seed_portal/index.php?1234
[[File:secure_access.png|400px|thumb|center|Purchaser email check]]
When this page is visited, it will request the purchaser's email address to confirm that the link user is the purchaser. This link will expire after 7 days or after downloading the tokens, the link can be force expired. IP addresses that repeatedly attempt to visit possible links will be blacklisted. Please email sales (at) esecutech.com for assistance or to re-enable the link if more than 7 days is needed.
</div>
<div id="Load_tokens">
== Load tokens from file ==
A uinf secret key file can be loaded into the UniOTP seed portal for testing and conversion purposes. See [[Virtual_OTP_token | virtual OTP token]] for creating a uinf file for testing purposes.

In the "Upload tokens" tab, please use the "Choose Files" button to upload .uinf secret key files.

XML and encrypted file support is planned for the future.
</div>
<div id="Convert_tokens">
== Convert seed file for different platforms ==
[[File:seedportal_Download.png|400px|thumb|center|Generate zip file with chosen formats]]
The Seed portal page provides 4 file types for different platforms:
<div class="mw-collapsible mw-collapsed">
CSV in base 16/Hex: commonly used by custom solutions
<div class="mw-collapsible-content">
*DUO format CSV: This format is a secret key container type used by DUO security: https://duo.com/
"Token serial name" , "secret key (in hex)", "counter"
*Generic format CSV: This format is a nice format for viewing with Excel and can be used by a custom solution easily
First line is header which provides format: "serial", "secret key (in hex)", "counter", "type (HOTP/TOTP/OCRA)", "timestamp (time last synchronized)", "digits", "authwnd (authentication window)", "timestep". 
Please note that the authentication window and timestep may not be needed, for example most authentication servers use a global default, and is not token specific. Timestep is provided as 60 even for HOTP tokens, as some servers have different behaviours to missing values, despite not been used.
</div>
</div>
<div class="mw-collapsible mw-collapsed">
CSV in base 32: Google authenticator
<div class="mw-collapsible-content">
*Generic format CSV: This format is a nice format for viewing with Excel and can be used by a custom solution easily
First line is header which provides format: "serial", "secret key (in base32)", "counter", "type (HOTP/TOTP/OCRA)", "timestamp (time last synchronized)", "digits", "authwnd (authentication window)", "timestep". 
Please note that the authentication window and timestep may not be needed, for example most authentication servers use a global default, and is not token specific. Timestep is provided as 60 even for HOTP tokens, as some servers have different behaviours to missing values, despite not been used.
</div>
</div>
<div class="mw-collapsible mw-collapsed">
XML in base 64: most commonly supported seed file format, eg. RCDev http://www.rcdevs.com/products/openotp/
<div class="mw-collapsible-content">
*Encrypted export is not supported by the Seed portal yet.
*Raw XML: XML formatted secret key file that conforms to: https://tools.ietf.org/html/rfc6030
This format is supported by most OTP authentication servers.
</div>
</div>
<div class="mw-collapsible mw-collapsed">
UINF: SecuTech's proprietary seed format.
<div class="mw-collapsible-content">
*Encrypted export is not supported by the Seed portal yet.
*Raw uinf file: Exports the secret key file in uinf format. Previously used by SecuTech's legacy management system, please retain this file for future use for token trouble shooting using the seed portal.
</div>
</div>
</div>
<div id="Synchronize_tokens">
== Test and Synchronize a token ==
To test if a token is out of synch due to repeatedly pressing the button on the token or a time lag from the onboard clock, please use this feature.
[[File:seedportal_virtualtoken.png|400px|thumb|center|Token troubleshooting]]

Please select a token from the list, it will be highlighted in a deep red and the serial name will appear next to: "Selected token:", the current OTP that the computer expects the OTP to be displaying based on the seed file is generated.

To synchronize a token, input atleast 1 OTP. Note that whilst it is possible to input 1 OTP for this operation, a single OTP is not recommended to be used over 50 OTP's. When synchronizing over large ranges, please use 2 OTP's. Default synch range is 3000, please set this accordingly and press "Synchronize OTP".

If successful, the seed for the synchronized token will be set to the current values found.
</div>
<div id="Search_tokens">
== Search for a lost serial number ==
In the event that a token's serial number is lost, for example the sticker is worn out and the token itself has been returned, it can be identified.

This process is identical to a synchronization process, however the tool will search through the defined range to find the matching OTP sequences on all seeds loaded.

Open the original uinf file (note that multiple uinf secret key files can be loaded into the tool), input 2 OTP's from the device and press search. If the token has been in use for some time and it is HOTP based, the uinf files may be out of synch to the token.

As a rule of thumb, the "search range" should be approximately 3 * number of days the token has been in use. It would be unusual for users to have more uses then this.
If thousands of tokens are used, multiple instances of the search can be run by splitting the secret key files using "Download tokens" tab, "Custom grouping".

Note that this process is time consuming, a minimum of 450 sequences are tested every second (more with a fast computer). For 1000 tokens with a search range of 1000 (roughly 1 year of HOTP token usage), it can take close to 1 hour to complete. In this event we recommend splitting the file into 4 parts and opening 4 different instances of the seed portal to quarter the time taken.

Chrome pauses javascript operations on pages that are not open, when attempting to run multiple instances, make sure that the browser tabs the seed portal instances are in, have been dragged next to each other and are visible.
</div>
<div id="troubleshoot_tokens">
== General troubleshooting for OTP servers and tokens ==
When setting up (or developing) OTP servers/authenticators and tokens, a common issue is with timezone conversions.

On the Token test and synchronize tab is the current Unix time, timestamp, and manual counter incrementor/decrementor.

The Unix time and "Check timestamp on external site" is useful for determining if the computer time is correct. A difference of more then a few seconds can cause issues with TOTP tokens.

The manual counter feature is useful for anyone creating their own authenticator and wishes to quickly test OTP's of a token.

It is possible to create your own UINF file for testing purposes, please navigate [[Virtual_OTP_token|here]] for more details.

</div>

Category:UniMate Video Guides

2018-09-12T07:29:37Z

Administrator: Blanked the page

Category:UniToken Quick Start Guides

2018-09-10T04:56:24Z

Administrator:

*[https://s3-ap-southeast-2.amazonaws.com/secutechsdkbucket/en/quick-start-guide/quick-start-guide-unitoken-EN201312.pdf UniToken Quick Start Guide]

Category:UniOTP Quick Start Guides

2018-09-10T04:55:28Z

Administrator:

* [https://s3-ap-southeast-2.amazonaws.com/secutechsdkbucket/en/quick-start-guide/quick-start-guide-uniotp-EN201703.pdf UniOTP Quick Start Guide]

Category:UniKey Quick Start Guides

2018-09-10T04:54:52Z

Administrator:

* [https://s3-ap-southeast-2.amazonaws.com/secutechsdkbucket/en/quick-start-guide/quick-start-guide-unikey-170818.pdf UniKey Quick Start Guide]

Category:UniMate Video Guides

2018-08-19T07:21:19Z

Administrator: Created page with "{{#evu:https://www.youtube.com/watch?v=N6B8vk3_S2w |alignment=right }}"

{{#evu:https://www.youtube.com/watch?v=N6B8vk3_S2w
|alignment=right
}}

Category:UniKey Quick Start Guides

2017-07-28T12:03:49Z

Administrator:

* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unikey-20170620.pdf UniKey Quick Start Guide]

UniKey Ultra Dual Photo

2017-04-29T01:58:22Z

Administrator:

[[category:UniKey_Gallery]]

[[Image:UniKey_Ultra_Dual-1.jpg|600px|200px]]

[[Image:UniKey Ultra Dual-2.jpg|600px|200px]]

[[Image:UniKey Ultra Dual-3.jpg|600px|200px]]

[[Image:Unikey_Ultra_Dual-4.jpg|600px|200px]]

UniKey Ultra Dual Photo

2017-04-29T01:56:30Z

Administrator: Created page with "category:UniKey_Gallery"

[[category:UniKey_Gallery]]

File:Unikey Ultra Dual-4.jpg

2017-04-29T01:51:49Z

Administrator:

File:UniKey Ultra Dual-3.jpg

2017-04-29T00:41:02Z

Administrator:

File:UniKey Ultra Dual-2.jpg

2017-04-29T00:30:19Z

Administrator:

File:UniKey Ultra Dual-1.jpg

2017-04-29T00:25:11Z

Administrator:

UniMate API Reference Error Codes

2016-07-06T01:52:10Z

Administrator:

[[category:UniMate API]]
== List of Error Codes ==

=== General Error Codes ===

<table class="wikitable">
<tr>
<th>Error Code</th>
<th>Macro Definition</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>S_OK </td>
<td>Success (no issues)</td>
</tr>
<tr>
<td>-1</td>
<td>S_DEVICE_FAILURE</td>
<td>No connection</td>
</tr>
<tr>
<td>-2</td>
<td>S_INVALID_PASSWORD</td>
<td>Password verification failed</td>
</tr>
<tr>
<td>-3</td>
<td>S_DEVICE_LOCK</td>
<td>Device locked</td>
</tr>
<tr>
<td>-4</td>
<td>S_NOT_ENOUGH_MEMORY</td>
<td>Insufficient memory</td>
</tr>
<tr>
<td>-5</td>
<td>S_INVALID_CERTIFICATE</td>
<td>Invalid certificate format</td>
</tr>
<tr>
<td>-6</td>
<td>S_INVALID_ALGORITHM</td>
<td>Invalid algorithm</td>
</tr>
<tr>
<td>-7</td>
<td>S_INVALID_PARAMETER</td>
<td>Invalid parameter</td>
</tr>
<tr>
<td>-8</td>
<td>S_UNKOWN_ERROR</td>
<td>Unknown error</td>
</tr>
<tr>
<td>-9</td>
<td>S_USER_CANCEL</td>
<td>Cancelled by the user</td>
</tr>
</table>

MediaWiki:Sidebar

2016-07-06T01:50:19Z

Administrator:

*Navigation
**mainpage|mainpage-description

*UniKey
**category:UniKey_API|UniKey API
**category:UniKey_Application_Solutions|UniKey Application Solutions
**category:UniKey_FAQ|UniKey FAQ
**category:UniKey_Gallery|UniKey Gallery
**category:UniKey_Hardware_Troubleshooting|UniKey Hardware Troubleshooting
**category:UniKey_Library_Integration_Guides|UniKey Library Integration Guides
**category:UniKey_Tools|UniKey Tools

*UniToken
**category:UniToken_API|UniToken API
**category:UniToken_FAQ|UniToken FAQ
**category:UniToken_Gallery|UniToken Gallery
**category:UniToken_Hardware_Troubleshooting|UniToken Hardware Troubleshooting
**category:UniToken_Integration_Guide|UniToken Integration Guides
**category:UniToken_Tools|UniToken Tools

*UniOTP
**category:UniOTP_API|UniOTP API
**category:UniOTP_FAQ|UniOTP FAQ
**category:UniOTP_Gallery|UniOTP Gallery
**category:UniOTP_Hardware_Troubleshooting|UniOTP Hardware Troubleshooting
**category:UniOTP_Integration_Solutions|UniOTP Integration Solutions
**category:UniOTP_Tools|UniOTP Tools

*UniMate
**category:UniMate API|UniMate API
**category:UniMate_FAQ|UniMate FAQ
**category:UniMate Family|UniMate Family
**category:UniMate_Gallery|UniMate Gallery
**category:UniMate_Manuals|UniMate Manuals

Category:UniMate FAQ

2016-07-01T04:30:32Z

Administrator: /* How can I begin using UniMate? */

[[category:Mobile Authentication]]
UniMate Frequently Asked Questions Category

=== What is UniMate? ===

UniMate is SecuTech's mobile authentication product family focusing on secure transaction authentication and platform interchangeability. UniMate employes two-factor authentication, the involvement of "something you have" and "something you know". The UniMate family comprises of tokens UniMate STD and UniMate Flex, secure card reader UniMate Reader, and USB to audio adapter UniMate Adapter.

=== How does UniMate work? ===

UniMate authentication utilises PKI technology, where employed certificates are securely stored within the UniMate device and are inaccessible without the appropriate permissions to interact with the device. UniMate leverages the TRRS audio port found on most, if not all, mobile devices for secured communication during use of the device, in addition to providing a USB interface for use and configuration on the desktop platform.

=== How can I begin using UniMate? ===

Please see the [[:category:UniMate Quick Start Guides|UniMate Quick Start Guides]].

=== What is PKI? ===

Public Key Infrastructure (PKI) is a set of hardware, software, people, policies, and procedures needed to create, manage, distribute, use, store, and revoke digital certificates.

=== Why use UniMate? ===

Using UniMate is safer than using a static password alone, as authentication requires two factors. The first factor is the physical UniMate device itself, which contains the digital certificate used during the authentication process. The second factor is the password to log onto the UniMate device before beginning the transaction process. These added factors in the authentication process make it substantially more difficult for unauthorised access than the use of a single factor, such as a password, alone.

=== What is the default PIN of UniMate? ===

The default Admin PIN is eight zeros, or "00000000", without quotation marks.
The default User PIN is eight ones, or "11111111", without quotation marks.

=== What should I do if my UniMate device is locked? ===

If the user account associated with your UniMate device is locked, please contact the administrator to unlock your user account.

=== What steps does SecuTech take to ensure UniMate is environmentally friendly? ===

SecuTech is committed to supplying products that are environmentally sustainable. All parts and production processes of UniMate devices are lead-free and ROHS-compliant.

=== Where can I receive further assistance? ===

We, at SecuTech, are dedicated to providing high-quality technical support to our customers. If you have any questions, please feel free to contact us at https://esecutech.com/support or support@esecutech.com.

Category:UniOTP Quick Start Guides

2016-07-01T04:11:56Z

Administrator: Created page with "* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-uniotp-20140522.pdf UniOTP Quick Start Guide]"

* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-uniotp-20140522.pdf UniOTP Quick Start Guide]

Main Page

2016-07-01T04:11:33Z

Administrator:

'''Welcome to the SecuTech Wiki'''

Information on our products and viewable manuals and guides are available on our Wiki.

Please note this Wiki is currently under construction and is continually updated.

<table cellspacing="0" cellpadding="0" border="0" style="width: 728px; height: 247px;">
<tr valign="top">
<td>
UniKey [Software Protection]
- [[:category:UniKey API|UniKey API Reference]]
- [[:category:UniKey Application Solutions|UniKey Application Solutions]]
- [[:category:UniKey FAQ|UniKey Frequently Asked Questions]]
- [[:category:UniKey Gallery|UniKey Gallery]]
- [[:category:UniKey Hardware Troubleshooting|UniKey Hardware Troubleshooting Guide]]
- [[:category:UniKey Library Integration Guides|UniKey Library Integration Guides]]
- [[:category:UniKey Quick Start Guides|UniKey Quick Start Guides]]
- [[:category:UniKey Tools|UniKey Tools]]
</td>
<td>
UniToken [USB Authentication]
- [[:category:UniToken API|UniToken API Reference]]
- [[:category:UniToken FAQ|UniToken Frequently Asked Questions]]
- [[:category:UniToken Gallery|UniToken Gallery]]
- [[:category:UniToken Hardware Troubleshooting|UniToken Hardware Troubleshooting Guide]]
- [[:category:UniToken Integration Guide|UniToken Integration Guide]]
- [[:category:UniToken Quick Start Guides|UniToken Quick Start Guides]]
- [[:category:UniToken Tools|UniToken Tools]]
</td>
</tr>
<tr valign="top">
<td>
UniOTP [One-time Password]
- [[:category:UniOTP API|UniOTP API Reference]]
- [[:category:UniOTP FAQ|UniOTP Frequently Asked Questions]]
- [[:category:UniOTP Gallery|UniOTP Gallery]]
- [[:category:UniOTP Integration Solutions|UniOTP Integration Solutions]]
- [[:category:UniOTP Quick Start Guides|UniOTP Quick Start Guides]]
- [[:category:UniOTP Tools|UniOTP Tools]]

</td>
<td>
UniMate [Mobile Authentication]
- [[:category:UniMate API|UniMate API Reference]]
- [[:category:UniMate Family|UniMate Family]]
- [[:category:UniMate FAQ|UniMate Frequently Asked Questions]]
- [[:category:UniMate Gallery|UniMate Gallery]]
- [[:category:UniMate Manuals|UniMate Manuals]]
- [[:category:UniMate Solutions|UniMate Solutions]]
- [[:category:UniMate Quick Start Guides|UniMate Quick Start Guides]]
</td>
<td>
</td>
</tr>
<tr valign="top">
<td>
Resources
- [[:category:Resources|Resources]]
</td>
</tr>
</table>

Category:UniMate Quick Start Guides

2016-07-01T04:10:54Z

Administrator: Created page with "* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unimate-std-flex-EN201607.pdf UniMate STD Quick Start Guide] * [http://files.esecutech.com/en/quick-start-..."

* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unimate-std-flex-EN201607.pdf UniMate STD Quick Start Guide]
* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unimate-std-flex-EN201607.pdf UniMate Flex Quick Start Guide]
* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unimate-usb-drive-EN201607.pdf UniMate USB Quick Start Guide]
* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unimate-usb-drive-EN201607.pdf UniMate Drive Quick Start Guide]

Category:UniToken Quick Start Guides

2016-07-01T04:09:21Z

Administrator: Created page with "*[http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unitoken-EN201312.pdf UniToken Quick Start Guide]"

*[http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unitoken-EN201312.pdf UniToken Quick Start Guide]

Category:UniKey Quick Start Guides

2016-07-01T04:08:14Z

Administrator: Created page with "* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unikey-EN2015.pdf UniKey Quick Start Guide]"

* [http://files.esecutech.com/en/quick-start-guide/quick-start-guide-unikey-EN2015.pdf UniKey Quick Start Guide]

Main Page

2016-07-01T04:06:48Z

Administrator:

'''Welcome to the SecuTech Wiki'''

Information on our products and viewable manuals and guides are available on our Wiki.

Please note this Wiki is currently under construction and is continually updated.

<table cellspacing="0" cellpadding="0" border="0" style="width: 728px; height: 247px;">
<tr valign="top">
<td>
UniKey [Software Protection]
- [[:category:UniKey API|UniKey API Reference]]
- [[:category:UniKey Application Solutions|UniKey Application Solutions]]
- [[:category:UniKey FAQ|UniKey Frequently Asked Questions]]
- [[:category:UniKey Gallery|UniKey Gallery]]
- [[:category:UniKey Hardware Troubleshooting|UniKey Hardware Troubleshooting Guide]]
- [[:category:UniKey Library Integration Guides|UniKey Library Integration Guides]]
- [[:category:UniKey Quick Start Guides|UniKey Quick Start Guides]]
- [[:category:UniKey Tools|UniKey Tools]]
</td>
<td>
UniToken [USB Authentication]
- [[:category:UniToken API|UniToken API Reference]]
- [[:category:UniToken FAQ|UniToken Frequently Asked Questions]]
- [[:category:UniToken Gallery|UniToken Gallery]]
- [[:category:UniToken Hardware Troubleshooting|UniToken Hardware Troubleshooting Guide]]
- [[:category:UniToken Integration Guide|UniToken Integration Guide]]
- [[:category:UniToken Quick Start Guides|UniToken Quick Start Guides]]
- [[:category:UniToken Tools|UniToken Tools]]
</td>
</tr>
<tr valign="top">
<td>
UniOTP [One-time Password]
- [[:category:UniOTP API|UniOTP API Reference]]
- [[:category:UniOTP FAQ|UniOTP Frequently Asked Questions]]
- [[:category:UniOTP Gallery|UniOTP Gallery]]
- [[:category:UniOTP Integration Solutions|UniOTP Integration Solutions]]
- [[:category:UniOTP Tools|UniOTP Tools]]

</td>
<td>
UniMate [Mobile Authentication]
- [[:category:UniMate API|UniMate API Reference]]
- [[:category:UniMate Family|UniMate Family]]
- [[:category:UniMate FAQ|UniMate Frequently Asked Questions]]
- [[:category:UniMate Gallery|UniMate Gallery]]
- [[:category:UniMate Manuals|UniMate Manuals]]
- [[:category:UniMate Solutions|UniMate Solutions]]
- [[:category:UniMate Quick Start Guides|UniMate Quick Start Guides]]
</td>
<td>
</td>
</tr>
<tr valign="top">
<td>
Resources
- [[:category:Resources|Resources]]
</td>
</tr>
</table>

Category:UniMate Solutions

2016-07-01T04:02:58Z

Administrator: Administrator moved page Category:UniMate to Category:UniMate Solutions without leaving a redirect

Main Page

2016-06-30T06:57:16Z

Administrator:

'''Welcome to the SecuTech Wiki'''

Information on our products and viewable manuals and guides are available on our Wiki.

Please note this Wiki is currently under construction and is continually updated.

<table cellspacing="0" cellpadding="0" border="0" style="width: 728px; height: 247px;">
<tr valign="top">
<td>
UniKey [Software Protection]
- [[:category:UniKey API|UniKey API Reference]]
- [[:category:UniKey Application Solutions|UniKey Application Solutions]]
- [[:category:UniKey FAQ|UniKey Frequently Asked Questions]]
- [[:category:UniKey Gallery|UniKey Gallery]]
- [[:category:UniKey Hardware Troubleshooting|UniKey Hardware Troubleshooting Guide]]
- [[:category:UniKey Library Integration Guides|UniKey Library Integration Guides]]
- [http://files.esecutech.com/marketing-materials/ProductsDoc/UniKey/UniKeyQuickStartGuide-2015.pdf UniKey Quick Start Guide]
- [[:category:UniKey Tools|UniKey Tools]]
</td>
<td>
UniToken [USB Authentication]
- [[:category:UniToken API|UniToken API Reference]]
- [[:category:UniToken FAQ|UniToken Frequently Asked Questions]]
- [[:category:UniToken Gallery|UniToken Gallery]]
- [[:category:UniToken Hardware Troubleshooting|UniToken Hardware Troubleshooting Guide]]
- [[:category:UniToken Integration Guide|UniToken Integration Guide]]
- [http://files.esecutech.com/marketing-materials/ProductsDoc/UniToken/UniToken_quickstart-130827EN.pdf UniToken Quick Start Guide]
- [[:category:UniToken Tools|UniToken Tools]]
</td>
</tr>
<tr valign="top">
<td>
UniOTP [One-time Password]
- [[:category:UniOTP API|UniOTP API Reference]]
- [[:category:UniOTP FAQ|UniOTP Frequently Asked Questions]]
- [[:category:UniOTP Gallery|UniOTP Gallery]]
- [[:category:UniOTP Integration Solutions|UniOTP Integration Solutions]]
- [[:category:UniOTP Tools|UniOTP Tools]]

</td>
<td>
UniMate [Mobile Authentication]
- [[:category:UniMate API|UniMate API Reference]]
- [[:category:UniMate Family|UniMate Family]]
- [[:category:UniMate FAQ|UniMate Frequently Asked Questions]]
- [[:category:UniMate Gallery|UniMate Gallery]]
- [[:category:UniMate Manuals|UniMate Manuals]]
- [[:category:UniMate|UniMate Documentation]]

</td>
<td>
</td>
</tr>
<tr valign="top">
<td>
Resources
- [[:category:Resources|Resources]]
</td>
</tr>
</table>

Main Page

2016-06-30T06:55:12Z

Administrator:

'''Welcome to the SecuTech Wiki'''

Information on our products and viewable manuals and guides are available on our Wiki.

Please note this Wiki is currently under construction and is continually updated.

<table cellspacing="0" cellpadding="0" border="0" style="width: 728px; height: 247px;">
<tr valign="top">
<td>
UniKey [Software Protection]
- [[:category:UniKey API|UniKey API Reference]]
- [[:category:UniKey Application Solutions|UniKey Application Solutions]]
- [[:category:UniKey FAQ|UniKey Frequently Asked Questions]]
- [[:category:UniKey Gallery|UniKey Gallery]]
- [[:category:UniKey Hardware Troubleshooting|UniKey Hardware Troubleshooting Guide]]
- [[:category:UniKey Library Integration Guides|UniKey Library Integration Guides]]
- [http://files.esecutech.com/marketing-materials/ProductsDoc/UniKey/UniKeyQuickStartGuide-2015.pdf UniKey Quick Start Guide]
- [[:category:UniKey Tools|UniKey Tools]]
</td>
<td>
UniToken [USB Authentication]
- [[:category:UniToken API|UniToken API Reference]]
- [[:category:UniToken FAQ|UniToken Frequently Asked Questions]]
- [[:category:UniToken Gallery|UniToken Gallery]]
- [[:category:UniToken Hardware Troubleshooting|UniToken Hardware Troubleshooting Guide]]
- [[:category:UniToken Integration Guide|UniToken Integration Guide]]
- [http://files.esecutech.com/marketing-materials/ProductsDoc/UniToken/UniToken_quickstart-130827EN.pdf UniToken Quick Start Guide]
- [[:category:UniToken Tools|UniToken Tools]]
</td>
</tr>
<tr valign="top">
<td>
UniOTP [One-time Password]
- [[:category:UniOTP API|UniOTP API Reference]]
- [[:category:UniOTP FAQ|UniOTP Frequently Asked Questions]]
- [[:category:UniOTP Gallery|UniOTP Gallery]]
- [[:category:UniOTP Integration Solutions|UniOTP Integration Solutions]]
- [[:category:UniOTP Tools|UniOTP Tools]]

</td>
<td>
UniMate [Mobile Authentication]
- [[:category:UniMate API|UniMate API Reference]]
- [[:category:UniMate Family|UniMate Family]]
- [[:category:UniMate FAQ|UniMate Frequently Asked Questions]]
- [[:category:UniMate Gallery|UniMate Gallery]]
- [[:category:UniMate Manuals|UniMate Manuals]]
- [[:category:UniMate|UniMate Documentation]]

</td>
<td>
</td>
</tr>
<tr valign="top">
<td>
Resources
- <a href="/wiki/index.php/Category:Resources" title="Category:Resources">Resources</a>
</td>
</tr>
</table>

MediaWiki:Sidebar

2016-06-30T06:47:22Z

Administrator:

*Navigation
**mainpage|mainpage-description

*UniKey
**category:UniKey_API|UniKey API
**category:UniKey_Application_Solutions|UniKey Application Solutions
**category:UniKey_FAQ|UniKey FAQ
**category:UniKey_Gallery|UniKey Gallery
**category:UniKey_Hardware_Troubleshooting|UniKey Hardware Troubleshooting
**category:UniKey_Library_Integration_Guides|UniKey Library Integration Guides
**category:UniKey_Tools|UniKey Tools

*UniToken
**category:UniToken_API|UniToken API
**category:UniToken_FAQ|UniToken FAQ
**category:UniToken_Gallery|UniToken Gallery
**category:UniToken_Hardware_Troubleshooting|UniToken Hardware Troubleshooting
**category:UniToken_Integration_Guide|UniToken Integration Guides
**category:UniToken_Tools|UniToken Tools

*UniOTP
**category:UniOTP_API|UniOTP API
**category:UniOTP_FAQ|UniOTP FAQ
**category:UniOTP_Gallery|UniOTP Gallery
**category:UniOTP_Hardware_Troubleshooting|UniOTP Hardware Troubleshooting
**category:UniOTP_Integration_Solutions|UniOTP Integration Solutions
**category:UniOTP_Tools|UniOTP Tools

*UniMate
**category:UniMate_FAQ|UniMate FAQ
**category:UniMate_Gallery|UniMate Gallery
**category:UniMate_Manuals|UniMate Manuals

MediaWiki:Sidebar

2016-06-30T06:45:15Z

Administrator:

*Navigation
**mainpage|mainpage-description

*Software Protection
**category:UniKey_Application_Solutions|UniKey Application Solutions
**category:UniKey_Library_Integration_Guides|UniKey Library Integration Guides
**category:UniKey_Tools|UniKey Tools
**category:UniKey_API|UniKey API
**category:UniKey_Hardware_Troubleshooting|UniKey Hardware Troubleshooting
**category:UniKey_FAQ|UniKey FAQ
**category:UniKey_Gallery|UniKey Gallery

*USB Authentication
**category:UniToken_Integration_Guide|UniToken Integration Guides
**category:UniToken_Tools|UniToken Tools
**category:UniToken_API|UniToken API
**category:UniToken_Hardware_Troubleshooting|UniToken Hardware Troubleshooting
**category:UniToken_FAQ|UniToken FAQ
**category:UniToken_Gallery|UniToken Gallery

*One-time Password
**category:UniOTP_Integration_Solutions|UniOTP Integration Solutions
**category:UniOTP_Tools|UniOTP Tools
**category:UniOTP_API|UniOTP API
**category:UniOTP_Hardware_Troubleshooting|UniOTP Hardware Troubleshooting
**category:UniOTP_FAQ|UniOTP FAQ
**category:UniOTP_Gallery|UniOTP Gallery

*Mobile Authentication
**category:UniMate_Manuals|UniMate Manuals
**category:UniMate_FAQ|UniMate FAQ
**category:UniMate_Gallery|UniMate Gallery

UniMate USB PKCS 11 Manual

2016-06-30T06:28:18Z

Administrator: /* Supported PKCS#11 Algorithms and API */

[[category:UniMate Manuals]]

<div id = "Table of Contents"></div>
==PKCS#11 Manual==

Version 2.0

<table class="wikitable">
<tr>
<td style="background-color: red;">Version</td>
<td style="background-color: red;">Date</td>
</tr>
<tr>
<td>1.0</td>
<td>2015.7</td>
</tr>
<tr>
<td>2.0</td>
<td>2016.7</td>
</tr>
</table>

The data and information contained in this document cannot be altered without the express written permission of SecuTech Solution Inc. No part of this document can be reproduced or transmitted for any purpose whatsoever, either by electronic or mechanical means.

The general terms of trade of SecuTech Solution Inc. apply. Diverging agreements must be made in writing.

Copyright SecuTech Solution Inc. All rights reserved.

WINDOWS is a registered trademark of Microsoft Corporation.

The WINDOWS-logo is a registered trademark (TM) of Microsoft Corporation.

Software License

The software and the enclosed documentation are copyright-protected. By installing the software, you agree to the conditions of the licensing agreement.

Licensing Agreement

SecuTech Solution Inc. (SecuTech for short) gives the buyer the simple, exclusive and non-transferable licensing right to use the software on one individual computer or networked computer system (LAN). Copying and any other form of reproduction of the software in full or in part as well as mixing and linking it with others is prohibited. The buyer is authorized to make one single copy of the software as backup. SecuTech reserves the right to change or improve the software without notice or to replace it with a new development. SecuTech is not obliged to inform the buyer of changes, improvements or new developments or to make these available to him. A legally binding promise of certain qualities is not given. SecuTech is not responsible for damage unless it is the result of deliberate action or negligence on the part of SecuTech or its aids and assistants. SecuTech accepts no responsibility of any kind for indirect, accompanying or subsequent damage.

Contact Information

Web: http://www.esecutech.com

Email: [mailto:sales@eSecuTech.com sales@esecutech.com]

Please Email any comments, suggestions or questions regarding this document or our products to us at: [mailto:sales@eSecuTech.com sales@esecutech.com]

 
; CE Attestation of Conformity
[[File:CE Attestation.png|left|100px|top]]
: UniMate is in conformity with the protection requirements of CE Directives 89/336/EEC Amending Directive 92/31/EEC. UniMate satisfies the limits and verifying methods: EN55022/CISPR 22 Class B, EN55024: 1998.
 
; FCC Standard
[[File:FCC.png|left|100px|top]]
: This device is in conformance with Part 15 of the FCC Rules and Regulation for Information Technology Equipment.
: Operation of this product is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation.
 
[[File:USB Logo.png|left|100px|top]] The equipment of UniMate is USBbased.
 
; Conformity to ISO 9001<nowiki>:</nowiki>2000
[[File:ISO 9001.png|left|100px|top]]
: The Quality System of SecuTech Solution Inc., including its implementation, meets the requirements of the standard ISO 9001:2000
 
; ROHS
[[File:ROHS.png|left|100px|top]]
: All UniMate products are environmentally friendly with ROHS certificates.
 

<div style="page-break-before:always"></div>

==Introduction==
PKCS#11 is a Public-Key Cryptography Standard (PKCS) for public key cryptography, developed by RSA Laboratories and includes both algorithm-specific and algorithm-independent implementation standards. It is an industry standard that defines a technology independent programming interface for cryptographic devices such as smart cards and PCMCIA cards. This standard specifies an application program interface
(API) called Cryptoki (Cryptographic Token Interface), to devices, either physical or virtual, which hold cryptographic information (keys and other data) and perform cryptographic functions. This API is used across many platforms and is powerful enough for most security-related applications. SecuTech uses PKCS#11 as the main API for UniMate programming. UniMate supports PKCS#11 applications via UniMate middleware.

The following files are needed when developing UniMate PKCS#11 applications:

<table class="wikitable">
<tr>
<td style="background-color: red;">Files</td>
<td style="background-color: red;">Path</td>
</tr>
<tr>
<td>Cryptoki.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>pkcs11.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>Pkcs11f.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>Pkcs11t.h/td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>UniMateP11.dll / UniMateP11.so</td>
<td>SDK\PKCS#11\Libraries\</td>
</tr>
</table>

The PKCS#11 module of UniMate supports the creation of the following objects:

<table class="wikitable">
<tr>
<td style="background-color: red;">Object Class</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>CKO_DATA</td>
<td>For data structures defined by the application</td>
</tr>
<tr>
<td>CKO_SECRET_KEY</td>
<td>For symmetric keys</td>
</tr>
<tr>
<td>CKO_CERTIFICATE</td>
<td>For X.509 v3 certificates</td>
</tr>
<tr>
<td>CKO_PUBLIC_KEY</td>
<td>For RSA/DSA public key</td>
</tr>
<tr>
<td>CKO_PRIVATE_KEY</td>
<td>For RSA/DSA private key</td>
</tr>
</table>

All the objects listed in the above table can be created with UniMate. The secure storage in UniMate is limited, so objects can only be created in memory but can NOT be stored in the UniMate secure storage. Only encryption keys and permanently present data need to be saved in the UniMate.

<div style="page-break-before:always"></div>

==Supported PKCS#11 Algorithms and API==

<table class="wikitable" >
<tr>
<td style="background-color: red;">Algorithm</td>
<td style="background-color: red;">Encrypt/Decrypt</td>
<td style="background-color: red;">Sign/Verify</td>
<td style="background-color: red;">Digest</td>
<td style="background-color: red;">Generate key/pair</td>
</tr>
<tr>
<td>CKM_RSA_PKCS_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td>✔</td>
</tr>
<tr>
<td>CKM_RSA_PKCS</td>
<td>✔</td>
<td>✔</td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DSA_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DSA</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_ECB</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_CBC</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_CBC_PAD</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC4_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC4</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>✔</td>
</tr>
<tr>
<td>CKM_DES_ECB</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES_CBC</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>✔</td>
</tr>
<tr>
<td>CKM_DES3_ECB</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_CBC</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_CBC_PAD</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_MD2</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_MD5</td>
<td></td>
<td></td>
<td>✔</td>
<td></td>
</tr>
<tr>
<td>CKM_SHA_1</td>
<td></td>
<td></td>
<td>✔</td>
<td></td>
</tr>
<tr>
<td>CKM_DH_PKCS_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_AES_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>✔</td>
</tr>
<tr>
<td>CKM_AES_CBC</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_AES_ECB</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
</table>

The table below lists all of the key sizes in the UniMate PKCS#11 library:

<table class="wikitable">
<tr>
<td style="background-color: red;">Algorithms</td>
<td style="background-color: red;">Key Sizes</td>
</tr>
<tr>
<td>CKM_RSA_PKCS_KEY_PAIR_GEN</td>
<td>1024bits, 2048bits</td>
</tr>
<tr>
<td>CKM_DES_KEY_GEN</td>
<td>64 bits</td>
</tr>
<tr>
<td>CKM_DES3_KEY_GEN</td>
<td>192 bits</td>
</tr>
<tr>
<td>CKM_AES_KEY_GEN</td>
<td>128 ~ 256 bits</td>
</tr>
</table>

<div style="page-break-before:always"></div>

==UniMate PKCS#11 Function Library==
The UniMate PKCS#11 library only implements the standard PKCS#11 APIs. Any other APIs beyond PKCS#11 are not implemented. If such an API is called, an error return code such as CKR_FUNCTION_NO_SUPPORT will be returned.

<table class="wikitable">
<tr>
<td style="background-color: red;">Category</td>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Supported</td>
</tr>
<tr>
<td rowspan="4">General Purpose Function</td>
<td>C_Initialize</td>
<td>YES</td>
</tr>
<tr>
<td>C_Finalize</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetFunctionList</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="9">Slot and UniMate Management Function</td>
<td>C_GetSlotList</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetSlotInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetUniMateInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_WaitForSlotEvent</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetMechanismList</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetMechanismInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_InitUniMate</td>
<td>YES</td>
</tr>
<tr>
<td>C_InitPIN</td>
<td>YES</td>
</tr>
<tr>
<td>C_SetPIN</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="8">Session Management Function</td>
<td>C_OpenSession</td>
<td>YES</td>
</tr>
<tr>
<td>C_CloseSession</td>
<td>YES</td>
</tr>
<tr>
<td>C_CloseAllSessions</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetSessionInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetOperationState</td>
<td>NO</td>
</tr>
<tr>
<td>C_SetOperationState</td>
<td>NO</td>
</tr>
<tr>
<td>C_Login</td>
<td>YES</td>
</tr>
<tr>
<td>C_Logout</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="9">Object Management Function</td>
<td>C_CreateObject</td>
<td>YES</td>
</tr>
<tr>
<td>C_CopyObject</td>
<td>NO</td>
</tr>
<tr>
<td>C_DestroyObject</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetObjectSize</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetAttributeValue</td>
<td>YES</td>
</tr>
<tr>
<td>C_SetAttributeValue</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjectsInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjects</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjectsFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="4">Encryption Function</td>
<td>C_EncryptInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Encrypt</td>
<td>YES</td>
</tr>
<tr>
<td>C_EncryptUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_EncryptFinal</td>
<td>YES</td>
</tr>
</table>

<div style="page-break-before:always"></div>

<table class="wikitable">
<tr>
<td style="background-color: red;">Category</td>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Supported</td>
</tr>
<tr>
<td rowspan="4">Decryption Function</td>
<td>C_DecryptInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Decrypt</td>
<td>YES</td>
</tr>
<tr>
<td>C_DecryptUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_DecryptFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="5">Message Digesting Function</td>
<td>C_DigestInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Digest</td>
<td>YES</td>
</tr>
<tr>
<td>C_DigestUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_DigestKey</td>
<td>NO</td>
</tr>
<tr>
<td>C_DigestFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="6">Signing and Hashing Function (MAC)</td>
<td>C_SignInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Sign</td>
<td>YES</td>
</tr>
<tr>
<td>C_SignUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignFinal</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignRecoverInit</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignRecover</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="6">Functions for Verifying Signatures and Hashing (MAC)</td>
<td>C_VerifyInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Verify</td>
<td>YES</td>
</tr>
<tr>
<td>C_VerifyUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyFinal</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyRecoverInit</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyRecover</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="4">Dual-Purpose Cryptographic Function</td>
<td>C_DigestEncryptUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_DecryptDigestUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignEncryptUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_DecryptVerifyUpdate</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="5">Key Management Function</td>
<td>C_GenerateKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_GenerateKeyPair</td>
<td>YES</td>
</tr>
<tr>
<td>C_WrapKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_UnwrapKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_DeriveKey</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="2">Random Number Generation Function</td>
<td>C_SeedRandom</td>
<td>NO</td>
</tr>
<tr>
<td>C_GenerateRandom</td>
<td>YES</td>
</tr>
<tr>
<td>Callback Function</td>
<td></td>
<td>YES</td>
</tr>
</table>

<div style="page-break-before:always"></div>

==Samples==
All the samples are implemented in C, and they all support PKCS#11 standard v.2.20. The samples are provided in: <code>SDK\PKCS#11\Sample</code>

<table class="wikitable">
<tr>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>C_Initialize</td>
<td>Initialize the PKCS#11 library</td>
</tr>
<tr>
<td>C_GetSlotList</td>
<td>Get the slot list</td>
</tr>
<tr>
<td>C_OpenSession</td>
<td>Open a session</td>
</tr>
<tr>
<td>C_Login</td>
<td>Log in</td>
</tr>
<tr>
<td>C_InitPIN</td>
<td>Initialize user PIN</td>
</tr>
<tr>
<td>C_Logout</td>
<td>Log out</td>
</tr>
<tr>
<td>C_FindObjectsInit</td>
<td>Initialize the search for any object</td>
</tr>
<tr>
<td>C_FindObjects</td>
<td>Find the objects which match</td>
</tr>
<tr>
<td>C_FindObjectsFinal</td>
<td>Cleanup the search</td>
</tr>
<tr>
<td>C_CloseSession</td>
<td>Close a session</td>
</tr>
<tr>
<td>C_GetAttributeValue</td>
<td>Get the attribute value</td>
</tr>
<tr>
<td>C_Finalize</td>
<td>Close PKCS #11 library</td>
</tr>
<tr>
<td>C_GenerateKeyPair</td>
<td>Generate a new public/private key pair</td>
</tr>
<tr>
<td>C_GenerateKey</td>
<td>Generate a secret key</td>
</tr>
<tr>
<td>C_WrapKey</td>
<td>Wrap (encrypt) a key</td>
</tr>
<tr>
<td>C_UnwrapKey</td>
<td>Unwrap (decrypt) a key</td>
</tr>
<tr>
<td>C_DeriveKey</td>
<td>Derive a key from a base key</td>
</tr>
<tr>
<td>C_SetPIN</td>
<td>Modify the current users PIN</td>
</tr>
<tr>
<td>C_GetTokenInfo</td>
<td>Get the slot information</td>
</tr>
<tr>
<td>C_SignInit</td>
<td>Initialize a signature</td>
</tr>
<tr>
<td>C_Sign</td>
<td>Sign data</td>
</tr>
<tr>
<td>C_SignUpdate</td>
<td>Continue a multiple-part signature</td>
</tr>
<tr>
<td>C_SignFinal</td>
<td>Finish a multiple-part signature</td>
</tr>
<tr>
<td>C_SignRecoverInit</td>
<td>Initialize a signature</td>
</tr>
<tr>
<td>C_SignRecover</td>
<td>Sign data, where the data can be recovered from the signature</td>
</tr>
<tr>
<td>C_DestroyObject</td>
<td>Destroy an object</td>
</tr>
</table>

<div style="page-break-before:always"></div>

<table class="wikitable">
<tr>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>C_GetFunctionList</td>
<td>Return the function list</td>
</tr>
<tr>
<td>C_GetMechanismList</td>
<td>Obtain a list of mechanism types</td>
</tr>
<tr>
<td>C_GetMechanismInfo</td>
<td>Obtain information about a particular mechanism possibly supported by a token</td>
</tr>
<tr>
<td>C_InitToken</td>
<td>Initialize a token</td>
</tr>
<tr>
<td>C_GetSessionInfo</td>
<td>Obtain information about the session</td>
</tr>
<tr>
<td>C_GetOperationState</td>
<td>Obtain the cryptographic state of a session</td>
</tr>
<tr>
<td>C_SetOperationState</td>
<td>Restore the cryptographic state of a session</td>
</tr>
<tr>
<td>C_EncryptInit</td>
<td>Initialize an encryption operation</td>
</tr>
<tr>
<td>C_Encrypt</td>
<td>Encrypt single-part data</td>
</tr>
<tr>
<td>C_EncryptUpdate</td>
<td>Continue a multiple-part encryption</td>
</tr>
<tr>
<td>C_EncryptFinal</td>
<td>Finish a multiple-part encryption operation</td>
</tr>
<tr>
<td>C_DecryptInit</td>
<td>Initialize a decryption</td>
</tr>
<tr>
<td>C_Decrypt</td>
<td>Decrypt encrypted data in a single part</td>
</tr>
<tr>
<td>C_DecryptUpdate</td>
<td>Continue a multiple-part decryption</td>
</tr>
<tr>
<td>C_DecryptFinal</td>
<td>Finish a multiple-part decryption</td>
</tr>
<tr>
<td>C_DigestInit</td>
<td>Initialize a message-digesting operation.</td>
</tr>
<tr>
<td>C_Digest</td>
<td>Digest data in a single part</td>
</tr>
<tr>
<td>C_DigestUpdate</td>
<td>Continue a multiple-part message-digesting</td>
</tr>
<tr>
<td>C_DigestFinal</td>
<td>Finish a multiple-part message-digesting</td>
</tr>
<tr>
<td>C_VerifyInit</td>
<td>Initialize a verification</td>
</tr>
<tr>
<td>C_Verify</td>
<td>Verify a signature</td>
</tr>
<tr>
<td>C_VerifyUpdate</td>
<td>Continue a multiple-part verification</td>
</tr>
<tr>
<td>C_VerifyFinal</td>
<td>Finish a multiple-part verification</td>
</tr>
<tr>
<td>C_VerifyRecoverInit</td>
<td>Initialize a signature verification</td>
</tr>
<tr>
<td>C_VerifyRecover</td>
<td>Verify a signature, where the data is recovered from the signature</td>
</tr>
<tr>
<td>C_SeedRandom</td>
<td>Mix additional seed material into the token's random number generator</td>
</tr>
<tr>
<td>C_GenerateRandom</td>
<td>Generate random data</td>
</tr>
<tr>
<td>C_GetFunctionStatus</td>
<td>Obtain an updated status of a function running in parallel with an application</td>
</tr>
<tr>
<td>C_CancelFunction</td>
<td>Cancel a function</td>
</tr>
<tr>
<td>C_WaitForSlotEvent</td>
<td>Wait for a slot event to occur</td>
</tr>
</table>

<div style="page-break-before:always"></div>

 
If you have any questions, please feel free to contact us at: http://www.esecutech.com/support or [mailto:support@esecutech.com support@esecutech.com]

 
{| style="border-style: solid; border-width: 1px;" align="center"
|
<gallery class="center" mode="nolines" widths=175px heights=50px caption="Follow Us!">
File:Twitter.png|'''[https://twitter.com/eSecuTech Twitter]'''
File:Facebook.png|'''[https://www.facebook.com/eSecuTech/ Facebook]'''
File:YouTube.png|'''[https://www.youtube.com/user/esecutech YouTube]'''
File:Linked In.png|'''[https://ca.linkedin.com/in/secutech-solutions-inc-39110b25 LinkedIn]'''
</gallery>
|}

 
[[File:Footer Logo List.png|left]]
 
About SecuTech

SecuTech Solution Inc. is a company specializing in data protection and strong authentication, providing total customer satisfaction in security systems & services for banks, financial institutions & other industries. Having extensive and in-depth experience within the information security market, SecuTech has drawn upon this experience to utilize today's cutting-edge technologies that are effective against increasingly sophisticated cyber attacks. Enabling enterprises, financial institutions, and government to safely adopt the economic benefits of mobile and cloud computing.

http://www.esecutech.com SecuTech Solution Inc.

{| class="wikitable"
|+ style="text-align:left;" | Contact Us:
!
! scope="col"| North America
! scope="col"| China
! scope="col"| Asia-Pacific
! scope="col"| EMEA
|-
! scope="row"| Address
| 1250 Boulevard Ren-Lvesque Ouest, #2200, Montreal, QC, H3B 4W8, Canada
| Level 12, #67 Bei Si Huan Xi Lu, Beijing, China, 100080
| Suite 5.14, 32 Delhi Rd, North Ryde, NSW, 2113, Australia
| 4 Cours Bayard 69002 Lyon, France
|-
! scope="row"| Phone
| +1 -888-259-5825
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Fax
| +1 -888-259-5825 ext.0
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Email
| [mailto:info@esecutech.com info@esecutech.com]
| [mailto:cn@esecutech.com cn@esecutech.com]
| [mailto:aus@esecutech.com aus@esecutech.com]
| [mailto:europe@esecutech.com europe@esecutech.com]
|}

Copyright 2012 SecuTech Solution Inc. All rights reserved. Reproduction in whole or in part without written permission from SecuTech is prohibited. SecuTech UniMate and the SecuTech logo are trademarks of SecuTech Inc. Windows and all other trademarks are properties of their respective owners. Features and specifications are subject to change without notice.

[[File:SecuTech Logo.png]]

 
[[#top|TOP]]

UniMate USB PKCS 11 Manual

2016-06-30T06:27:36Z

Administrator:

[[category:UniMate Manuals]]

<div id = "Table of Contents"></div>
==PKCS#11 Manual==

Version 2.0

<table class="wikitable">
<tr>
<td style="background-color: red;">Version</td>
<td style="background-color: red;">Date</td>
</tr>
<tr>
<td>1.0</td>
<td>2015.7</td>
</tr>
<tr>
<td>2.0</td>
<td>2016.7</td>
</tr>
</table>

The data and information contained in this document cannot be altered without the express written permission of SecuTech Solution Inc. No part of this document can be reproduced or transmitted for any purpose whatsoever, either by electronic or mechanical means.

The general terms of trade of SecuTech Solution Inc. apply. Diverging agreements must be made in writing.

Copyright SecuTech Solution Inc. All rights reserved.

WINDOWS is a registered trademark of Microsoft Corporation.

The WINDOWS-logo is a registered trademark (TM) of Microsoft Corporation.

Software License

The software and the enclosed documentation are copyright-protected. By installing the software, you agree to the conditions of the licensing agreement.

Licensing Agreement

SecuTech Solution Inc. (SecuTech for short) gives the buyer the simple, exclusive and non-transferable licensing right to use the software on one individual computer or networked computer system (LAN). Copying and any other form of reproduction of the software in full or in part as well as mixing and linking it with others is prohibited. The buyer is authorized to make one single copy of the software as backup. SecuTech reserves the right to change or improve the software without notice or to replace it with a new development. SecuTech is not obliged to inform the buyer of changes, improvements or new developments or to make these available to him. A legally binding promise of certain qualities is not given. SecuTech is not responsible for damage unless it is the result of deliberate action or negligence on the part of SecuTech or its aids and assistants. SecuTech accepts no responsibility of any kind for indirect, accompanying or subsequent damage.

Contact Information

Web: http://www.esecutech.com

Email: [mailto:sales@eSecuTech.com sales@esecutech.com]

Please Email any comments, suggestions or questions regarding this document or our products to us at: [mailto:sales@eSecuTech.com sales@esecutech.com]

 
; CE Attestation of Conformity
[[File:CE Attestation.png|left|100px|top]]
: UniMate is in conformity with the protection requirements of CE Directives 89/336/EEC Amending Directive 92/31/EEC. UniMate satisfies the limits and verifying methods: EN55022/CISPR 22 Class B, EN55024: 1998.
 
; FCC Standard
[[File:FCC.png|left|100px|top]]
: This device is in conformance with Part 15 of the FCC Rules and Regulation for Information Technology Equipment.
: Operation of this product is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation.
 
[[File:USB Logo.png|left|100px|top]] The equipment of UniMate is USBbased.
 
; Conformity to ISO 9001<nowiki>:</nowiki>2000
[[File:ISO 9001.png|left|100px|top]]
: The Quality System of SecuTech Solution Inc., including its implementation, meets the requirements of the standard ISO 9001:2000
 
; ROHS
[[File:ROHS.png|left|100px|top]]
: All UniMate products are environmentally friendly with ROHS certificates.
 

<div style="page-break-before:always"></div>

==Introduction==
PKCS#11 is a Public-Key Cryptography Standard (PKCS) for public key cryptography, developed by RSA Laboratories and includes both algorithm-specific and algorithm-independent implementation standards. It is an industry standard that defines a technology independent programming interface for cryptographic devices such as smart cards and PCMCIA cards. This standard specifies an application program interface
(API) called Cryptoki (Cryptographic Token Interface), to devices, either physical or virtual, which hold cryptographic information (keys and other data) and perform cryptographic functions. This API is used across many platforms and is powerful enough for most security-related applications. SecuTech uses PKCS#11 as the main API for UniMate programming. UniMate supports PKCS#11 applications via UniMate middleware.

The following files are needed when developing UniMate PKCS#11 applications:

<table class="wikitable">
<tr>
<td style="background-color: red;">Files</td>
<td style="background-color: red;">Path</td>
</tr>
<tr>
<td>Cryptoki.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>pkcs11.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>Pkcs11f.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>Pkcs11t.h/td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>UniMateP11.dll / UniMateP11.so</td>
<td>SDK\PKCS#11\Libraries\</td>
</tr>
</table>

The PKCS#11 module of UniMate supports the creation of the following objects:

<table class="wikitable">
<tr>
<td style="background-color: red;">Object Class</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>CKO_DATA</td>
<td>For data structures defined by the application</td>
</tr>
<tr>
<td>CKO_SECRET_KEY</td>
<td>For symmetric keys</td>
</tr>
<tr>
<td>CKO_CERTIFICATE</td>
<td>For X.509 v3 certificates</td>
</tr>
<tr>
<td>CKO_PUBLIC_KEY</td>
<td>For RSA/DSA public key</td>
</tr>
<tr>
<td>CKO_PRIVATE_KEY</td>
<td>For RSA/DSA private key</td>
</tr>
</table>

All the objects listed in the above table can be created with UniMate. The secure storage in UniMate is limited, so objects can only be created in memory but can NOT be stored in the UniMate secure storage. Only encryption keys and permanently present data need to be saved in the UniMate.

<div style="page-break-before:always"></div>

==Supported PKCS#11 Algorithms and API==

<table class="wikitable" >
<tr>
<td style="background-color: red;">Algorithm</td>
<td style="background-color: red;">Encrypt/Decrypt</td>
<td style="background-color: red;">Sign/Verify</td>
<td style="background-color: red;">Digest</td>
<td style="background-color: red;">Generate key/pair</td>
</tr>
<tr>
<td>CKM_RSA_PKCS_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td>✔</td>
</tr>
<tr>
<td>CKM_RSA_PKCS</td>
<td>✔</td>
<td>✔</td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DSA_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DSA</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_ECB</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_CBC</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_CBC_PAD</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC4_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC4</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>✔</td>
</tr>
<tr>
<td>CKM_DES_ECB</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES_CBC</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>✔</td>
</tr>
<tr>
<td>CKM_DES3_ECB</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_CBC</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_CBC_PAD</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_MD2</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_MD5</td>
<td></td>
<td></td>
<td>✔</td>
<td></td>
</tr>
<tr>
<td>CKM_SHA_1</td>
<td></td>
<td></td>
<td>✔</td>
<td></td>
</tr>
<tr>
<td>CKM_DH_PKCS_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_AES_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>✔</td>
</tr>
<tr>
<td>CKM_AES_CBC</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_AES_ECB</td>
<td>✔</td>
<td></td>
<td></td>
<td></td>
</tr>
</table>

The table below lists all of the key sizes in the UniMate PKCS#11 library:

<table class="wikitable">
<tr>
<td style="background-color: red;">Algorithms</td>
<td style="background-color: red;">Key Sizes</td>
</tr>
<tr>
<td>CKM_RSA_PKCS_KEY_PAIR_GEN</td>
<td>1024bits, 2048bits</td>
</tr>
<tr>
<td>CKM_DES_KEY_GEN</td>
<td>64 bits</td>
</tr>
<tr>
<td>CKM_DES3_KEY_GEN</td>
<td>192 bits</td>
</tr>
<tr>
<td>CKM_AES_KEY_GEN</td>
<td>128 ～ 256 bits</td>
</tr>
</table>

<div style="page-break-before:always"></div>

==UniMate PKCS#11 Function Library==
The UniMate PKCS#11 library only implements the standard PKCS#11 APIs. Any other APIs beyond PKCS#11 are not implemented. If such an API is called, an error return code such as CKR_FUNCTION_NO_SUPPORT will be returned.

<table class="wikitable">
<tr>
<td style="background-color: red;">Category</td>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Supported</td>
</tr>
<tr>
<td rowspan="4">General Purpose Function</td>
<td>C_Initialize</td>
<td>YES</td>
</tr>
<tr>
<td>C_Finalize</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetFunctionList</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="9">Slot and UniMate Management Function</td>
<td>C_GetSlotList</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetSlotInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetUniMateInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_WaitForSlotEvent</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetMechanismList</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetMechanismInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_InitUniMate</td>
<td>YES</td>
</tr>
<tr>
<td>C_InitPIN</td>
<td>YES</td>
</tr>
<tr>
<td>C_SetPIN</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="8">Session Management Function</td>
<td>C_OpenSession</td>
<td>YES</td>
</tr>
<tr>
<td>C_CloseSession</td>
<td>YES</td>
</tr>
<tr>
<td>C_CloseAllSessions</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetSessionInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetOperationState</td>
<td>NO</td>
</tr>
<tr>
<td>C_SetOperationState</td>
<td>NO</td>
</tr>
<tr>
<td>C_Login</td>
<td>YES</td>
</tr>
<tr>
<td>C_Logout</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="9">Object Management Function</td>
<td>C_CreateObject</td>
<td>YES</td>
</tr>
<tr>
<td>C_CopyObject</td>
<td>NO</td>
</tr>
<tr>
<td>C_DestroyObject</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetObjectSize</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetAttributeValue</td>
<td>YES</td>
</tr>
<tr>
<td>C_SetAttributeValue</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjectsInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjects</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjectsFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="4">Encryption Function</td>
<td>C_EncryptInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Encrypt</td>
<td>YES</td>
</tr>
<tr>
<td>C_EncryptUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_EncryptFinal</td>
<td>YES</td>
</tr>
</table>

<div style="page-break-before:always"></div>

<table class="wikitable">
<tr>
<td style="background-color: red;">Category</td>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Supported</td>
</tr>
<tr>
<td rowspan="4">Decryption Function</td>
<td>C_DecryptInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Decrypt</td>
<td>YES</td>
</tr>
<tr>
<td>C_DecryptUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_DecryptFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="5">Message Digesting Function</td>
<td>C_DigestInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Digest</td>
<td>YES</td>
</tr>
<tr>
<td>C_DigestUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_DigestKey</td>
<td>NO</td>
</tr>
<tr>
<td>C_DigestFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="6">Signing and Hashing Function (MAC)</td>
<td>C_SignInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Sign</td>
<td>YES</td>
</tr>
<tr>
<td>C_SignUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignFinal</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignRecoverInit</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignRecover</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="6">Functions for Verifying Signatures and Hashing (MAC)</td>
<td>C_VerifyInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Verify</td>
<td>YES</td>
</tr>
<tr>
<td>C_VerifyUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyFinal</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyRecoverInit</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyRecover</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="4">Dual-Purpose Cryptographic Function</td>
<td>C_DigestEncryptUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_DecryptDigestUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignEncryptUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_DecryptVerifyUpdate</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="5">Key Management Function</td>
<td>C_GenerateKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_GenerateKeyPair</td>
<td>YES</td>
</tr>
<tr>
<td>C_WrapKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_UnwrapKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_DeriveKey</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="2">Random Number Generation Function</td>
<td>C_SeedRandom</td>
<td>NO</td>
</tr>
<tr>
<td>C_GenerateRandom</td>
<td>YES</td>
</tr>
<tr>
<td>Callback Function</td>
<td></td>
<td>YES</td>
</tr>
</table>

<div style="page-break-before:always"></div>

==Samples==
All the samples are implemented in C, and they all support PKCS#11 standard v.2.20. The samples are provided in: <code>SDK\PKCS#11\Sample</code>

<table class="wikitable">
<tr>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>C_Initialize</td>
<td>Initialize the PKCS#11 library</td>
</tr>
<tr>
<td>C_GetSlotList</td>
<td>Get the slot list</td>
</tr>
<tr>
<td>C_OpenSession</td>
<td>Open a session</td>
</tr>
<tr>
<td>C_Login</td>
<td>Log in</td>
</tr>
<tr>
<td>C_InitPIN</td>
<td>Initialize user PIN</td>
</tr>
<tr>
<td>C_Logout</td>
<td>Log out</td>
</tr>
<tr>
<td>C_FindObjectsInit</td>
<td>Initialize the search for any object</td>
</tr>
<tr>
<td>C_FindObjects</td>
<td>Find the objects which match</td>
</tr>
<tr>
<td>C_FindObjectsFinal</td>
<td>Cleanup the search</td>
</tr>
<tr>
<td>C_CloseSession</td>
<td>Close a session</td>
</tr>
<tr>
<td>C_GetAttributeValue</td>
<td>Get the attribute value</td>
</tr>
<tr>
<td>C_Finalize</td>
<td>Close PKCS #11 library</td>
</tr>
<tr>
<td>C_GenerateKeyPair</td>
<td>Generate a new public/private key pair</td>
</tr>
<tr>
<td>C_GenerateKey</td>
<td>Generate a secret key</td>
</tr>
<tr>
<td>C_WrapKey</td>
<td>Wrap (encrypt) a key</td>
</tr>
<tr>
<td>C_UnwrapKey</td>
<td>Unwrap (decrypt) a key</td>
</tr>
<tr>
<td>C_DeriveKey</td>
<td>Derive a key from a base key</td>
</tr>
<tr>
<td>C_SetPIN</td>
<td>Modify the current users PIN</td>
</tr>
<tr>
<td>C_GetTokenInfo</td>
<td>Get the slot information</td>
</tr>
<tr>
<td>C_SignInit</td>
<td>Initialize a signature</td>
</tr>
<tr>
<td>C_Sign</td>
<td>Sign data</td>
</tr>
<tr>
<td>C_SignUpdate</td>
<td>Continue a multiple-part signature</td>
</tr>
<tr>
<td>C_SignFinal</td>
<td>Finish a multiple-part signature</td>
</tr>
<tr>
<td>C_SignRecoverInit</td>
<td>Initialize a signature</td>
</tr>
<tr>
<td>C_SignRecover</td>
<td>Sign data, where the data can be recovered from the signature</td>
</tr>
<tr>
<td>C_DestroyObject</td>
<td>Destroy an object</td>
</tr>
</table>

<div style="page-break-before:always"></div>

<table class="wikitable">
<tr>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>C_GetFunctionList</td>
<td>Return the function list</td>
</tr>
<tr>
<td>C_GetMechanismList</td>
<td>Obtain a list of mechanism types</td>
</tr>
<tr>
<td>C_GetMechanismInfo</td>
<td>Obtain information about a particular mechanism possibly supported by a token</td>
</tr>
<tr>
<td>C_InitToken</td>
<td>Initialize a token</td>
</tr>
<tr>
<td>C_GetSessionInfo</td>
<td>Obtain information about the session</td>
</tr>
<tr>
<td>C_GetOperationState</td>
<td>Obtain the cryptographic state of a session</td>
</tr>
<tr>
<td>C_SetOperationState</td>
<td>Restore the cryptographic state of a session</td>
</tr>
<tr>
<td>C_EncryptInit</td>
<td>Initialize an encryption operation</td>
</tr>
<tr>
<td>C_Encrypt</td>
<td>Encrypt single-part data</td>
</tr>
<tr>
<td>C_EncryptUpdate</td>
<td>Continue a multiple-part encryption</td>
</tr>
<tr>
<td>C_EncryptFinal</td>
<td>Finish a multiple-part encryption operation</td>
</tr>
<tr>
<td>C_DecryptInit</td>
<td>Initialize a decryption</td>
</tr>
<tr>
<td>C_Decrypt</td>
<td>Decrypt encrypted data in a single part</td>
</tr>
<tr>
<td>C_DecryptUpdate</td>
<td>Continue a multiple-part decryption</td>
</tr>
<tr>
<td>C_DecryptFinal</td>
<td>Finish a multiple-part decryption</td>
</tr>
<tr>
<td>C_DigestInit</td>
<td>Initialize a message-digesting operation.</td>
</tr>
<tr>
<td>C_Digest</td>
<td>Digest data in a single part</td>
</tr>
<tr>
<td>C_DigestUpdate</td>
<td>Continue a multiple-part message-digesting</td>
</tr>
<tr>
<td>C_DigestFinal</td>
<td>Finish a multiple-part message-digesting</td>
</tr>
<tr>
<td>C_VerifyInit</td>
<td>Initialize a verification</td>
</tr>
<tr>
<td>C_Verify</td>
<td>Verify a signature</td>
</tr>
<tr>
<td>C_VerifyUpdate</td>
<td>Continue a multiple-part verification</td>
</tr>
<tr>
<td>C_VerifyFinal</td>
<td>Finish a multiple-part verification</td>
</tr>
<tr>
<td>C_VerifyRecoverInit</td>
<td>Initialize a signature verification</td>
</tr>
<tr>
<td>C_VerifyRecover</td>
<td>Verify a signature, where the data is recovered from the signature</td>
</tr>
<tr>
<td>C_SeedRandom</td>
<td>Mix additional seed material into the token's random number generator</td>
</tr>
<tr>
<td>C_GenerateRandom</td>
<td>Generate random data</td>
</tr>
<tr>
<td>C_GetFunctionStatus</td>
<td>Obtain an updated status of a function running in parallel with an application</td>
</tr>
<tr>
<td>C_CancelFunction</td>
<td>Cancel a function</td>
</tr>
<tr>
<td>C_WaitForSlotEvent</td>
<td>Wait for a slot event to occur</td>
</tr>
</table>

<div style="page-break-before:always"></div>

 
If you have any questions, please feel free to contact us at: http://www.esecutech.com/support or [mailto:support@esecutech.com support@esecutech.com]

 
{| style="border-style: solid; border-width: 1px;" align="center"
|
<gallery class="center" mode="nolines" widths=175px heights=50px caption="Follow Us!">
File:Twitter.png|'''[https://twitter.com/eSecuTech Twitter]'''
File:Facebook.png|'''[https://www.facebook.com/eSecuTech/ Facebook]'''
File:YouTube.png|'''[https://www.youtube.com/user/esecutech YouTube]'''
File:Linked In.png|'''[https://ca.linkedin.com/in/secutech-solutions-inc-39110b25 LinkedIn]'''
</gallery>
|}

 
[[File:Footer Logo List.png|left]]
 
About SecuTech

SecuTech Solution Inc. is a company specializing in data protection and strong authentication, providing total customer satisfaction in security systems & services for banks, financial institutions & other industries. Having extensive and in-depth experience within the information security market, SecuTech has drawn upon this experience to utilize today's cutting-edge technologies that are effective against increasingly sophisticated cyber attacks. Enabling enterprises, financial institutions, and government to safely adopt the economic benefits of mobile and cloud computing.

http://www.esecutech.com SecuTech Solution Inc.

{| class="wikitable"
|+ style="text-align:left;" | Contact Us:
!
! scope="col"| North America
! scope="col"| China
! scope="col"| Asia-Pacific
! scope="col"| EMEA
|-
! scope="row"| Address
| 1250 Boulevard Ren-Lvesque Ouest, #2200, Montreal, QC, H3B 4W8, Canada
| Level 12, #67 Bei Si Huan Xi Lu, Beijing, China, 100080
| Suite 5.14, 32 Delhi Rd, North Ryde, NSW, 2113, Australia
| 4 Cours Bayard 69002 Lyon, France
|-
! scope="row"| Phone
| +1 -888-259-5825
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Fax
| +1 -888-259-5825 ext.0
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Email
| [mailto:info@esecutech.com info@esecutech.com]
| [mailto:cn@esecutech.com cn@esecutech.com]
| [mailto:aus@esecutech.com aus@esecutech.com]
| [mailto:europe@esecutech.com europe@esecutech.com]
|}

Copyright 2012 SecuTech Solution Inc. All rights reserved. Reproduction in whole or in part without written permission from SecuTech is prohibited. SecuTech UniMate and the SecuTech logo are trademarks of SecuTech Inc. Windows and all other trademarks are properties of their respective owners. Features and specifications are subject to change without notice.

[[File:SecuTech Logo.png]]

 
[[#top|TOP]]

UniMate USB CSP Manual

2016-06-30T06:24:44Z

Administrator:

[[category:UniMate Manuals]]

<div id = "Table of Contents"></div>
==CSP Manual==

Version 2.0

<table class="wikitable">
<tr>
<td style="background-color: red;">Version</td>
<td style="background-color: red;">Date</td>
</tr>
<tr>
<td>1.0</td>
<td>2015.7</td>
</tr>
<tr>
<td>2.0</td>
<td>2016.7</td>
</tr>
</table>

The data and information contained in this document cannot be altered without the express written permission of SecuTech Solution Inc. No part of this document can be reproduced or transmitted for any purpose whatsoever, either by electronic or mechanical means.

The general terms of trade of SecuTech Solution Inc. apply. Diverging agreements must be made in writing.

Copyright SecuTech Solution Inc. All rights reserved.

WINDOWS is a registered trademark of Microsoft Corporation.

The WINDOWS-logo is a registered trademark (TM) of Microsoft Corporation.

Software License

The software and the enclosed documentation are copyright-protected. By installing the software, you agree to the conditions of the licensing agreement.

Licensing Agreement

SecuTech Solution Inc. (SecuTech for short) gives the buyer the simple, exclusive and non-transferable licensing right to use the software on one individual computer or networked computer system (LAN). Copying and any other form of reproduction of the software in full or in part as well as mixing and linking it with others is prohibited. The buyer is authorized to make one single copy of the software as backup. SecuTech reserves the right to change or improve the software without notice or to replace it with a new development. SecuTech is not obliged to inform the buyer of changes, improvements or new developments or to make these available to him. A legally binding promise of certain qualities is not given. SecuTech is not responsible for damage unless it is the result of deliberate action or negligence on the part of SecuTech or its aids and assistants. SecuTech accepts no responsibility of any kind for indirect, accompanying or subsequent damage.

Contact Information

Web: http://www.esecutech.com

Email: [mailto:sales@eSecuTech.com sales@esecutech.com]

Please Email any comments, suggestions or questions regarding this document or our products to us at: [mailto:sales@eSecuTech.com sales@esecutech.com]

 
; CE Attestation of Conformity
[[File:CE Attestation.png|left|100px|top]]
: UniMate is in conformity with the protection requirements of CE Directives 89/336/EEC Amending Directive 92/31/EEC. UniMate satisfies the limits and verifying methods: EN55022/CISPR 22 Class B, EN55024: 1998.
 
; FCC Standard
[[File:FCC.png|left|100px|top]]
: This device is in conformance with Part 15 of the FCC Rules and Regulation for Information Technology Equipment.
: Operation of this product is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation.
 
[[File:USB Logo.png|left|100px|top]] The equipment of UniMate is USBbased.
 
; Conformity to ISO 9001<nowiki>:</nowiki>2000
[[File:ISO 9001.png|left|100px|top]]
: The Quality System of SecuTech Solution Inc., including its implementation, meets the requirements of the standard ISO 9001:2000
 
; ROHS
[[File:ROHS.png|left|100px|top]]
: All UniMate products are environmentally friendly with ROHS certificates.
 

<div style="page-break-before:always"></div>

==Introduction==

CAPI (Cryptographic Application Programming Interface), developed by Microsoft as part of Microsoft Windows, is an interface to a library of functions software developers can call upon for security and cryptography services. It is intended for use by developers of applications for MS Windows platforms.

CAPI allows multiple cryptographic service providers (CSP) to coexist on the same computer and to be used in the same application. It is also possible to associate a CSP with a particular smartcard, so that smartcard-enabled Windows applications will call the correct CSP. MS Windows contains many helper functions that application developers may use to simplify code when working with cryptographic functions or with complicated data structures (such as certificates).

Choosing which API to use when developing applications is dependent on the needs of the particular application.

==Algorithms and APIs==

<table class="wikitable">
<tr >
<td style="background-color: red;" colspan="2">Connection functions</td>
</tr>
<tr>
<td>CryptAcquireContext</td>
<td>Create a context and initialize access to CSP which must be specified</td>
</tr>
<tr>
<td>CryptReleaseContext</td>
<td>Release the context created in CryptAcquireContext and other resources</td>
</tr>
<tr>
<td>CryptGetProvParam</td>
<td>Return information related to CSP</td>
</tr>
<tr>
<td>CryptSetProvParam</td>
<td>Set parameters of CSP</td>
</tr>
<tr >
<td style="background-color: red;" colspan="2">Generate and exchange key functions</td>
</tr>
<tr>
<td>CryptGenKey</td>
<td>Generate key or key pair</td>
</tr>
<tr>
<td>CryptDeriveKey</td>
<td>Derive a session key from a data hash and guarantee the generated key difference</td>
</tr>
<tr>
<td>CryptSetKeyParam</td>
<td>Set key attributes</td>
</tr>
<tr>
<td>CryptGetKeyParam</td>
<td>Retrieves the data that controls the operations of the key</td>
</tr>
<tr>
<td>CryptExportKey</td>
<td>Export key from container</td>
</tr>
<tr>
<td>CryptImportKey</td>
<td>Import the key to CSP container</td>
</tr>
<tr>
<td>CryptDestroyKey</td>
<td>Release key handle, after which the handle will be invalid and cannot be accessed</td>
</tr>
<tr>
<td>CryptDuplicateKey</td>
<td>Create a duplicate of the key</td>
</tr>
<tr>
<td>CryptGenRandom</td>
<td>Generate random data</td>
</tr>
<tr>
<td>CryptGetUserKey</td>
<td>Gets a handle to a permanent user key</td>
</tr>
<tr >
<td style="background-color: red;" colspan="2">Data encryption function</td>
</tr>
<tr>
<td>CryptDecrypt</td>
<td>Decrypt document</td>
</tr>
<tr>
<td>CryptEncrypt</td>
<td>Encrypt document</td>
</tr>
<tr>
<td>CryptCreateHash</td>
<td>Returns a handle to a created hashing object and initializes it</td>
</tr>
<tr>
<td>CryptDestroyHash</td>
<td>Delete hashing object handle</td>
</tr>
<tr>
<td>CryptDuplicateHash</td>
<td>Duplicates a hashing object, including state, up to when the duplication is done</td>
</tr>
<tr>
<td>CryptHashData</td>
<td>Hash input data</td>
</tr>
<tr>
<td>CryptGetHashParam</td>
<td>Get the hash value and data that control the operations of the hash object</td>
</tr>
<tr>
<td>CryptHashSessionKey</td>
<td>Hash a session key without revealing the key value to the application</td>
</tr>
<tr>
<td>CryptSetHashParam</td>
<td>Set the attributes of a hash object, such as specific algorithm or initial contents</td>
</tr>
<tr>
<td>CryptSignHash</td>
<td>Sign a hash object</td>
</tr>
<tr>
<td>CryptVerifySignature</td>
<td>Verifies the signature of a hash object</td>
</tr>
</table>

<div style="page-break-before:always"></div>

==Samples==
All the samples are implemented in the C++ language, and they all support the MS-CAPI standard. We provide the samples below, located in path: <code>SDK\CSP(MS-CAPI)\Sample</code>

<table class="wikitable">
<tr>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Files</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>Algorithm</td>
<td>algorithmTest.cpp algorithmTest.h</td>
<td>This sample demonstrates operations on symmetric keys, hashing and asymmetric keys.</td>
</tr>
<tr>
<td>Container</td>
<td>kcsTest.cpp kcsTest.h</td>
<td>This sample demonstrates enumeration, deletion and creation of files.</td>
</tr>
<tr>
<td>Certificates</td>
<td>listcerts.cpp listcerts.h</td>
<td>This sample demonstrates operations on a certificate list.</td>
</tr>
</table>

===Algorithm samples===
These samples include 3 functions:
* <code>int GenerateAlgTest(ULONG ulALG)</code>
* <code>int DeviceAlgTest(ULONG ulALG)</code>
* <code>int RstTest(ULONG version)</code>

GenerateAlgTest is used for DES key generation, encryption and decryption operations:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Create a container</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. Retrieve parameters that govern the operations of a CSP</td>
<td>CryptGetProvParam</td>
</tr>
<tr>
<td>3. Generate a key</td>
<td>CryptGenKey</td>
</tr>
<tr>
<td>4. Data Encryption</td>
<td>CryptEncrypt</td>
</tr>
<tr>
<td>5. Data Decryption</td>
<td>CryptDecrypt</td>
</tr>
</table>

DeviceAlgTest is used for key derivation, data encryption and decryption operations:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Create a container</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. Initiate the hashing of a stream of data</td>
<td>CryptCreateHash</td>
</tr>
<tr>
<td>3. Add data to a specified hash object</td>
<td>CryptHashData</td>
</tr>
<tr>
<td>4. Derive a key</td>
<td>CryptDeriveKey</td>
</tr>
<tr>
<td>5. Data Encryption</td>
<td>CryptEncrypt</td>
</tr>
<tr>
<td>6. Data Decryption</td>
<td>CryptDecrypt</td>
</tr>
</table>

RstTest is used for RSA key generation, data encryption and decryption operations:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Create a container</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. Generate a key</td>
<td>CryptGenKey</td>
</tr>
<tr>
<td>3. Data Encryption</td>
<td>CryptEncrypt</td>
</tr>
<tr>
<td>4. Data Decryption</td>
<td>CryptDecrypt</td>
</tr>
</table>

===Container sample===
This sample demonstrates how to enumerate, add and delete containers with the function - <code>int kcsTest(ULONG ulActive)</code>

For enumerating a container: 

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Acquire a "VERIFYCONTEXT" handle</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. Enumerate through the key containers</td>
<td>CryptGetProvParam</td>
</tr>
<tr>
<td>3. Acquire a handle to the key container found</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>4. Try to get a handle to the key pair</td>
<td>CryptGetUserKey</td>
</tr>
<tr>
<td>5. Get key permissions</td>
<td>CryptGetKeyParam</td>
</tr>
<tr>
<td>6. Display key permissions</td>
<td></td>
</tr>
</table>

For adding a container:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Check whether the container already exists</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. If not, create a container</td>
<td>CryptAcquireContext</td>
</tr>
</table>

For deleting a container:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Check whether the container already exists</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. If it does, release the handle to the context</td>
<td>CryptReleaseContext</td>
</tr>
<tr>
<td>3. Delete the container</td>
<td>CryptAcquireContext</td>
</tr>
</table>

===List Certificate sample===
This sample demonstrates how to enumerate certificates with the function - <code>int listcerts(void)</code>

For enumerating certificates:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Open a handle to the certificate store: MY\\UniMateStore</td>
<td>CertOpenStore</td>
</tr>
<tr>
<td>2. Go over each and every certificate within the certificate store</td>
<td>CertEnumCertificatesInStore</td>
</tr>
<tr>
<td>3. Get and display the subject name from the certificate</td>
<td>CertGetNameString</td>
</tr>
</table>

<div style="page-break-before:always"></div>

==PKI package==
UniMate provides a PKI package for developers and end users respectively. The package provides the UniMate PKI installation, if you want to use the PKI package, you must install it.

===Installation===
The UniMate PKI package can be found in the redists folder of the SDK.

For the developer package, double click the icon to run PKI package.exe, and follow the instructions below:

Click Install.

[[File:UniMate PKI Setup.PNG]]

 
Afterwards, click Finish to close the setup wizard.

[[File:UniMate PKI Finish.PNG]]

===Uninstallation===
To uninstall the software, select <code>Start Menu -- All apps -- UniMate Drive\PKI package\uninstall</code> (on Windows 8/10 you may need to right-click the file in the folder, mouse over More and select Open file location). Otherwise, by default the uninstaller is located in: <code>C:\Users\<your_username>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\UniMate Drive\PKI package</code>

Click OK and restart your computer to finish the uninstallation.

[[File:UniMate PKI Uninstall.PNG]]

<div style="page-break-before:always"></div>

 
If you have any questions, please feel free to contact us at: http://www.esecutech.com/support or [mailto:support@esecutech.com support@esecutech.com]

 
{| style="border-style: solid; border-width: 1px;" align="center"
|
<gallery class="center" mode="nolines" widths=175px heights=50px caption="Follow Us!">
File:Twitter.png|'''[https://twitter.com/eSecuTech Twitter]'''
File:Facebook.png|'''[https://www.facebook.com/eSecuTech/ Facebook]'''
File:YouTube.png|'''[https://www.youtube.com/user/esecutech YouTube]'''
File:Linked In.png|'''[https://ca.linkedin.com/in/secutech-solutions-inc-39110b25 LinkedIn]'''
</gallery>
|}

 
[[File:Footer Logo List.png|left]]
 
About SecuTech

SecuTech Solution Inc. is a company specializing in data protection and strong authentication, providing total customer satisfaction in security systems & services for banks, financial institutions & other industries. Having extensive and in-depth experience within the information security market, SecuTech has drawn upon this experience to utilize today's cutting-edge technologies that are effective against increasingly sophisticated cyber attacks. Enabling enterprises, financial institutions, and government to safely adopt the economic benefits of mobile and cloud computing.

http://www.esecutech.com SecuTech Solution Inc.

{| class="wikitable"
|+ style="text-align:left;" | Contact Us:
!
! scope="col"| North America
! scope="col"| China
! scope="col"| Asia-Pacific
! scope="col"| EMEA
|-
! scope="row"| Address
| 1250 Boulevard Ren-Lvesque Ouest, #2200, Montreal, QC, H3B 4W8, Canada
| Level 12, #67 Bei Si Huan Xi Lu, Beijing, China, 100080
| Suite 5.14, 32 Delhi Rd, North Ryde, NSW, 2113, Australia
| 4 Cours Bayard 69002 Lyon, France
|-
! scope="row"| Phone
| +1 -888-259-5825
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Fax
| +1 -888-259-5825 ext.0
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Email
| [mailto:info@esecutech.com info@esecutech.com]
| [mailto:cn@esecutech.com cn@esecutech.com]
| [mailto:aus@esecutech.com aus@esecutech.com]
| [mailto:europe@esecutech.com europe@esecutech.com]
|}

Copyright 2012 SecuTech Solution Inc. All rights reserved. Reproduction in whole or in part without written permission from SecuTech is prohibited. SecuTech UniMate and the SecuTech logo are trademarks of SecuTech Inc. Windows and all other trademarks are properties of their respective owners. Features and specifications are subject to change without notice.

[[File:SecuTech Logo.png]]

 
[[#top|TOP]]

UniMate USB User Manual

2016-06-30T03:29:50Z

Administrator:

[[category:UniMate Manuals]]

<div id = "Table of Contents"></div>
==UniMate Manual==

Version 2.0

<table class="wikitable">
<tr>
<td style="background-color: red;">Version</td>
<td style="background-color: red;">Date</td>
</tr>
<tr>
<td>1.0</td>
<td>2015.7</td>
</tr>
<tr>
<td>2.0</td>
<td>2016.7</td>
</tr>
</table>

The data and information contained in this document cannot be altered without the express written permission of SecuTech Solution Inc. No part of this document can be reproduced or transmitted for any purpose whatsoever, either by electronic or mechanical means.

The general terms of trade of SecuTech Solution Inc. apply. Diverging agreements must be made in writing.

Copyright SecuTech Solution Inc. All rights reserved.

WINDOWS is a registered trademark of Microsoft Corporation.

The WINDOWS-logo is a registered trademark (TM) of Microsoft Corporation.

Software License

The software and the enclosed documentation are copyright-protected. By installing the software, you agree to the conditions of the licensing agreement.

Licensing Agreement

SecuTech Solution Inc. (SecuTech for short) gives the buyer the simple, exclusive and non-transferable licensing right to use the software on one individual computer or networked computer system (LAN). Copying and any other form of reproduction of the software in full or in part as well as mixing and linking it with others is prohibited. The buyer is authorized to make one single copy of the software as backup. SecuTech reserves the right to change or improve the software without notice or to replace it with a new development. SecuTech is not obliged to inform the buyer of changes, improvements or new developments or to make these available to him. A legally binding promise of certain qualities is not given. SecuTech is not responsible for damage unless it is the result of deliberate action or negligence on the part of SecuTech or its aids and assistants. SecuTech accepts no responsibility of any kind for indirect, accompanying or subsequent damage.

Contact Information

Web: http://www.esecutech.com

Email: [mailto:sales@eSecuTech.com sales@esecutech.com]

Please Email any comments, suggestions or questions regarding this document or our products to us at: [mailto:sales@eSecuTech.com sales@esecutech.com]

 
; CE Attestation of Conformity
[[File:CE Attestation.png|left|100px|top]]
: UniMate is in conformity with the protection requirements of CE Directives 89/336/EEC Amending Directive 92/31/EEC. UniMate satisfies the limits and verifying methods: EN55022/CISPR 22 Class B, EN55024: 1998.
 
; FCC Standard
[[File:FCC.png|left|100px|top]]
: This device is in conformance with Part 15 of the FCC Rules and Regulation for Information Technology Equipment.
: Operation of this product is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation.
 
[[File:USB Logo.png|left|100px|top]] The equipment of UniMate is USBbased.
 
; Conformity to ISO 9001<nowiki>:</nowiki>2000
[[File:ISO 9001.png|left|100px|top]]
: The Quality System of SecuTech Solution Inc., including its implementation, meets the requirements of the standard ISO 9001:2000
 
; ROHS
[[File:ROHS.png|left|100px|top]]
: All UniMate products are environmentally friendly with ROHS certificates.
 

==Overview==

The UniMate device, hereinafter referred to as UniMate, is a mobile authenticator and information security PKI product based on CCID technology (except UniMate Drive) and is a secure container for digital credentials. An advanced processor and secure memory is built into the UniMate device to provide security for exchanging, storing and handling electronic information.

UniMate has achieved an effective rights management and provides a highly-secure file system. The built-in processor achieves fast and efficient information processing.

UniMate supports PKCS#11, CSP and Value Added APIs (CD-ROM and Partition). The abundant samples provided in the SDK help bring ease to integration.

UniMate supports iOS, Android and a multitude of other devices through either a USB port using the CCID protocol or 3.5mm TRRS audio jack.

==UniMate Features==

;Universal features of UniMate:
*Globally unique hardware ID.
*Customizable software ID.
*Smart card based.
*On-board encryption.
*Two levels of PIN management mechanism.
*A secure file system.
*Up to 64KB of memory.
*Stylish and cute case.
*Lead free.

===UniMate Drive===

The UniMate Drive is a mobile authenticator and information security PKI product which can store key certificates. UniMate Drive includes storage types: U-Disk and CD-ROM. You can set up the storage size using the Partition tool and the Value Added library, ISO files can also be loaded into CD-ROM. You can also format the U-Disk and copy files into it, and so on. The total capacity of the UniMate Drive is between 2 to 32 GB, you can partition it as you wish. UniMate Drive supports PKCS#11, CSP and Value Added APIs (CD-ROM and Partition).

<gallery mode="packed" heights=425px>
UniMate Drive Architecture.jpeg
UniMate Drive Architecture Win.jpeg
</gallery>

===UniMate Flex===
UniMate Flex is an interactive hybrid mobile authentication token designed particularly for use in banking. The two-factor authentication device makes use of a high-performance smart card, a LED display and confirmation buttons to verify the secondary form of authentication. Users can visually confirm transaction information on-screen and press the confirmation button to approve only authorized transactions.
 UniMate Flex features PKI based digital certificate and private key storage, as well as on-board encryption, with the ability to generate and store RSA secret key pairs within the key.

[[File:UniMate Collage.jpeg|center|675px|top]]

===UniMate USB===

[[File:UniMate USB Rot.png|left|95px|top]]
[[File:UniMate USB Collage Rot.png|right|375px|top]]

UniMate USB is a FIPS 140-2 algorithm certified smart card USB authentication token, and utilizes smart card technology for strong authentication. Smart card technology allows for highly robust authentication and verification solutions.

; Organizational Use
----
; Enhanced Business
: With secure access in place, organizations can enable business through network connectivity and online services anytime, anywhere, with confidence.
; Security
: UniMate USB provides robust protection of sensitive business data from unauthorized access.
; Cost Effective
: UniMate USB reduces password administration costs and losses from data breaches, and provides multiple flexible solutions in one platform.
 
; Personal Use
----
; Identity Protection
: UniMate USB provides individuals with a secure digital identity protected from theft and abuse.
; Portability and Convenience
: UniMate USB enables users to access their credentials securely wherever they go, whenever they want.

 

[[File:FLEX Architecture *nix.jpeg|375px]]
[[File:FLEX Architecture Mobile.jpeg|375px]]
[[File:FLEX Architecture Win.jpeg|375px]]

 
[[#Table of Contents|CONTENTS]]

==Security==

Security is the most important part in the UniMate system, which involves an identification and verification method, including the file access permission control mechanism inside the UniMate, a confidential access system. This security attribute is changed based on the current state of the device, when the card is reset or after the UniMate has finished some commands.

===PIN===
The following table describes different key types and use.
<table class="wikitable">
<tr>
<td style="background-color: red;">PIN Type</td>
<td style="background-color: red;">Use</td>
</tr>
<tr>
<td>User PIN</td>
<td>Directory level authentication. Control different users' read and write permissions. Generate key pairs. Certificate management. Sign and so on.</td>
</tr>
<tr>
<td>Admin PIN</td>
<td>Ensures the security during the card initialization OR is used to reset User PIN/unlock a user.</td>
</tr>
</table>

User PIN: a personal identification number which is firstly hashed and then stored in the device.

Admin PIN: a console identification number.

===Factory default settings===

The default User PIN is 11111111 and the default Admin PIN is 00000000.
 
[[#Table of Contents|CONTENTS]]

==SDK==

<table class="wikitable">
<tr>
<td style="background-color: red;">Components</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>CSP (MS-CAPI)</td>
<td>Declaration of standardized identifiers and interface of CSP CSP libraries Redists/PKI package.exe Samples for CSP CSP Manual.pdf</td>
</tr>
<tr>
<td>Documents</td>
<td>Manual.pdf (UniMate manual)</td>
</tr>
<tr>
<td>PKCS#11</td>
<td>Declaration of the standardized identifiers and interface of PKCS PKCS libraries Samples for PKCS PKCS#11.pdf</td>
</tr>
<tr>
<td>Utilities</td>
<td>Utilities Installation (Console setup.exe, Monitor setup.exe) Utilities Manual</td>
</tr>
<tr>
<td>Value Added API</td>
<td>Declaration of the standardized identifiers and interface of Value Added API Value Added API libraries Samples for Value Added API API Manual.pdf</td>
</tr>
<tr>
<td>Quick Start.pdf</td>
<td>Product overview Software introduction Utilities introduction Factory default settings</td>
</tr>
<tr>
<td>ReadMe.txt</td>
<td>Changelog</td>
</tr>
</table>
 
[[#Table of Contents|CONTENTS]]

==Applying Digital Certificates==

UniMate provides a perfect container for digital certificates, supporting X.509 digital certificates. The UniMate PKI package is middleware that provides digital certificate usage.

A digital certificate and authenticated access is needed to use the UniMate, as without it, any operation on the UniMate is forbidden. In this part, we will introduce how to apply digital certificates. We will take the VeriSign certificate and Microsoft Certificate as examples.

===Applying Microsoft Certificates===

[[File:Cert Address.jpeg|500px]]

Insert a UniMate into the USB port first, and start IE to open the Microsoft certificate application page. This is the home page of the certificate application site. Firstly, you should click Request a certificate.

[[File:CertWelcome.png|500px]]
 
And then, select advanced certificate request.

[[File:CertRequestCrop.png|500px]]
 
On the page of Advanced Certificate Request, select Create and submit a request to this CA.

[[File:AdvCertRequestCrop.png|500px]]
 
For a certificate template, select Smartcard User in the list; for CSP, select UniMateDRIVE CSP v2.0.

[[File:AdvCertRequestOptions.png|500px]]
 
Then, a window will appear to ask you to type in your UniMates PIN. Click OK. The system will generate a certificate automatically.

[[File:User Pin.png|500px]]
 
Click Install this certificate for installation.

[[File:Cert Issued Crop.jpeg|500px]]
 
After installation, the system will prompt that the certificate has been successfully installed.

[[File:Cert Installed Crop.jpeg|500px]]

===Using Digital Certificates===

SecuTech provides a series of solutions about the use of digital certificates, in the aspects of IE, Outlook, PDF, Office, and so on.

For detailed instructions about this, please download the related integration guides from www.eSecuTech.com
 
[[#Table of Contents|CONTENTS]]
==Specifications==

===UniMate Drive===
<table class="wikitable">
<tr>
<td style="background-color: red;" colspan="2">Key Features</td>
</tr>
<tr>
<td colspan="2">Driverless Operation 2GB, 4GB, 8GB, 16GB and 32GB</td>
</tr>
<tr>
<td>Selective Mass Storage</td>
<td>Normal Partition Virtual CD-ROM</td>
</tr>
<tr>
<td>Dimensions</td>
<td>57x16x8 mm</td>
</tr>
<tr>
<td>Weight</td>
<td>9g</td>
</tr>
<tr>
<td>Min. Operating Voltage</td>
<td>5V</td>
</tr>
<tr>
<td>Current Consumption</td>
<td><= 50 mA</td>
</tr>
<tr>
<td>Operating Temperature</td>
<td>0℃ to 70℃</td>
</tr>
<tr>
<td>Storage Temperature</td>
<td>-10℃ to 85℃</td>
</tr>
<tr>
<td>Humidity Rate</td>
<td>0-70% without condensation</td>
</tr>
<tr>
<td>Casing</td>
<td>Tamper-evident Metal</td>
</tr>
<tr>
<td>Memory Data Retention</td>
<td>At least 10 years</td>
</tr>
<tr>
<td>Memory Cell Rewrites</td>
<td>At least 100,000 times</td>
</tr>
<tr>
<td>PKI</td>
<td>PKCS#11 MS-CAPI</td>
</tr>
<tr>
<td>Onboard Encryption Algorithms</td>
<td>1024- and 2048-bit RSA 128- and 192-bit AES 64-bit DES and 192-bit TDES</td>
</tr>
<tr>
<td>Onboard Hashing</td>
<td>160-bit SHA-1</td>
</tr>
<tr>
<td>Operating System Compatibility</td>
<td>Linux Windows 2000, XP, 2003, Vista, 7 and 8 Windows Server 2008 and Server 2012</td>
</tr>
</table>

===UniMate Flex===

<table class="wikitable">
<tr>
<td style="background-color: red;" colspan="2">Hardware</td>
</tr>
<tr>
<td>Dimensions</td>
<td>65x36x11.4 mm</td>
</tr>
<tr>
<td>Weight</td>
<td>23g</td>
</tr>
<tr>
<td>Audio Interface</td>
<td>3.5mm TRRS</td>
</tr>
<tr>
<td>USB Interface</td>
<td>USB Type A</td>
</tr>
<tr>
<td>Display</td>
<td>LCD</td>
</tr>
<tr>
<td>Hardware ID</td>
<td>64-bit Globally Unique</td>
</tr>
<tr>
<td>Internal Memory</td>
<td>> 16KB</td>
</tr>
<tr>
<td>Mobile Device Software</td>
<td>Audio Authentication Interface</td>
</tr>
<tr>
<td>Casing</td>
<td>Tamper-evident Metal</td>
</tr>
<tr>
<td>Middleware</td>
<td>PKCS#11 MS-CAPI Audio Authentication API X.509 Digital Certificate</td>
</tr>
<tr>
<td style="background-color: red;" colspan="2">Performance</td>
</tr>
<tr>
<td>Min. Operating Voltage</td>
<td>5V</td>
</tr>
<tr>
<td>Current Consumption</td>
<td><= 50 mA</td>
</tr>
<tr>
<td>Operation Temperature</td>
<td>0℃ to 70℃</td>
</tr>
<tr>
<td>Storage Temperature</td>
<td>-10℃ to 85℃</td>
</tr>
<tr>
<td>Humidity Rate</td>
<td>0-70% without condensation</td>
</tr>
<tr>
<td>Memory Data Retention</td>
<td>At least 10 years</td>
</tr>
<tr>
<td>Memory Cell Rewriters</td>
<td>At least 100,000 times</td>
</tr>
<tr>
<td>Supported Platforms</td>
<td>Mobile OS: iOS, Android, Symbian, Windows Phone PC: Windows, Linus, Mac OS X</td>
</tr>
</table>

===UniMate USB===

<table class="wikitable">
<tr>
<td style="background-color: red;" colspan="2">Key Features</td>
</tr>
<tr>
<td colspan="2">PKI token with CCID interface Embedded Smart Card Onboard Encryption Three-level Permission System Secure File System Auto-lock Mechanism MS-CAPI, PKCS#11 and X.509 v3 Standard Compliant Globally Unique Hardware ID (32-bit) User-Defined Token ID Lead-Free Robust Case</td>
</tr>
<tr>
<td style="background-color: red;" colspan="2">Hardware</td>
</tr>
<tr>
<td>Dimensions</td>
<td>52.8x17x7 mm</td>
</tr>
<tr>
<td>Weight</td>
<td>9g</td>
</tr>
<tr>
<td>Interface</td>
<td>USB</td>
</tr>
<tr>
<td style="background-color: red;" colspan="2">Performance</td>
</tr>
<tr>
<td>Min. Operating Voltage</td>
<td>5V</td>
</tr>
<tr>
<td>Current Consumption</td>
<td><= 50 mA</td>
</tr>
<tr>
<td>Operation Temperature</td>
<td>0℃ to 70℃</td>
</tr>
<tr>
<td>Storage Temperature</td>
<td>-10℃ to 85℃</td>
</tr>
<tr>
<td>Humidity Rate</td>
<td>0-70% without condensation</td>
</tr>
<tr>
<td>PKI</td>
<td>PKCS#11 MS-CAPI</td>
</tr>
<tr>
<td>Onboard Encryption Algorithms</td>
<td>1024- and 2048-bit RSA 128- and 192-bit AES 64-bit DES and 192-bit TDES</td>
</tr>
<tr>
<td>Onboard Hashing</td>
<td>160-bit SHA-1</td>
</tr>
<tr>
<td>Supported Platforms</td>
<td>Linux Windows 2000, XP, 2003, Vista, 7 and 8 Windows Server 2008 and Server 2012</td>
</tr>
<tr>
<td>Software Developers</td>
<td>UniMate USBAPI libraries in Windows and Linux UniMate USB Console for management of UniMate USB devices UniMate USB PKI middleware for PKCS# 11 and MS-CAPI applications UniMate USB IE ActiveX Control, Firefox Plugin</td>
</tr>
<tr>
<td>Software - Users</td>
<td>UniMate USB Monitor for registration and management of user digital certificates</td>
</tr>
</table>
 
[[#Table of Contents|CONTENTS]]

==Frequently Asked Questions==

===What is UniMate?===

UniMate is SecuTech's mobile authentication product family focusing on secure transaction authentication and platform interchangeability by employing two-factor authentication.

===How does UniMate work?===

UniMate authentication utilizes PKI technology, where certificates are securely stored within theUniMate device and are inaccessible without the appropriate permissions to interact with the device.

The TRRS audio port found on most mobile devices is used for secure communication during use of the device, in addition to providing a micro USB interface for use and configuration on a desktop platform.

===What is PKI?===

Public Key Infrastructure (PKI) is a set of hardware, software, people, policies, and procedures needed to create, manage, distribute, use, store, and revoke digital certificates.

===What algorithms are supported?===

UniMate supports 2048-bit RSA, 1024-bit RSA, 128-bit AES, 192-bit AES, 64-bit DES, and 192-bit TDES.

===What is the middleware?===

The middleware contains PKCS#11, MS-CAPI, and Audio Authentication APIs and X.509 Digital Certificates.

===What is the default PIN?===

The default Admin PIN is eight zeros, or
"00000000", the default User PIN is eight ones, or "11111111", without quotation marks.

===Where can I receive further assistance?===

If you have any questions, please feel free to contact us at: http://www.esecutech.com/support or [mailto:support@esecutech.com support@esecutech.com]

{| style="border-style: solid; border-width: 1px;" align="center"
|
<gallery class="center" mode="nolines" widths=175px heights=50px caption="Follow Us!">
File:Twitter.png|'''[https://twitter.com/eSecuTech Twitter]'''
File:Facebook.png|'''[https://www.facebook.com/eSecuTech/ Facebook]'''
File:YouTube.png|'''[https://www.youtube.com/user/esecutech YouTube]'''
File:Linked In.png|'''[https://ca.linkedin.com/in/secutech-solutions-inc-39110b25 LinkedIn]'''
</gallery>
|}

 
[[File:Footer Logo List.png|left]]
 
About SecuTech

SecuTech Solution Inc. is a company specializing in data protection and strong authentication, providing total customer satisfaction in security systems & services for banks, financial institutions & other industries. Having extensive and in-depth experience within the information security market, SecuTech has drawn upon this experience to utilize today's cutting-edge technologies that are effective against increasingly sophisticated cyber attacks. Enabling enterprises, financial institutions, and government to safely adopt the economic benefits of mobile and cloud computing.

http://www.esecutech.com SecuTech Solution Inc.

{| class="wikitable"
|+ style="text-align:left;" | Contact Us:
!
! scope="col"| North America
! scope="col"| China
! scope="col"| Asia-Pacific
! scope="col"| EMEA
|-
! scope="row"| Address
| 1250 Boulevard Ren-Lvesque Ouest, #2200, Montreal, QC, H3B 4W8, Canada
| Level 12, #67 Bei Si Huan Xi Lu, Beijing, China, 100080
| Suite 5.14, 32 Delhi Rd, North Ryde, NSW, 2113, Australia
| 4 Cours Bayard 69002 Lyon, France
|-
! scope="row"| Phone
| +1 -888-259-5825
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Fax
| +1 -888-259-5825 ext.0
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Email
| [mailto:info@esecutech.com info@esecutech.com]
| [mailto:cn@esecutech.com cn@esecutech.com]
| [mailto:aus@esecutech.com aus@esecutech.com]
| [mailto:europe@esecutech.com europe@esecutech.com]
|}

Copyright 2012 SecuTech Solution Inc. All rights reserved. Reproduction in whole or in part without written permission from SecuTech is prohibited. SecuTech UniMate and the SecuTech logo are trademarks of SecuTech Inc. Windows and all other trademarks are properties of their respective owners. Features and specifications are subject to change without notice.

[[File:SecuTech Logo.png]]

 
[[#top|TOP]]

UniMate USB PKCS 11 Manual

2016-06-30T03:18:25Z

Administrator:

[[category:UniMate Manuals]]

<div id = "Table of Contents"></div>
==PKCS#11 Manual==

Version 2.0

<table class="wikitable">
<tr>
<td style="background-color: red;">Version</td>
<td style="background-color: red;">Date</td>
</tr>
<tr>
<td>1.0</td>
<td>2015.7</td>
</tr>
<tr>
<td>2.0</td>
<td>2016.7</td>
</tr>
</table>

The data and information contained in this document cannot be altered without the express written permission of SecuTech Solution Inc. No part of this document can be reproduced or transmitted for any purpose whatsoever, either by electronic or mechanical means.

The general terms of trade of SecuTech Solution Inc. apply. Diverging agreements must be made in writing.

Copyright SecuTech Solution Inc. All rights reserved.

WINDOWS is a registered trademark of Microsoft Corporation.

The WINDOWS-logo is a registered trademark (TM) of Microsoft Corporation.

Software License

The software and the enclosed documentation are copyright-protected. By installing the software, you agree to the conditions of the licensing agreement.

Licensing Agreement

SecuTech Solution Inc. (SecuTech for short) gives the buyer the simple, exclusive and non-transferable licensing right to use the software on one individual computer or networked computer system (LAN). Copying and any other form of reproduction of the software in full or in part as well as mixing and linking it with others is prohibited. The buyer is authorized to make one single copy of the software as backup. SecuTech reserves the right to change or improve the software without notice or to replace it with a new development. SecuTech is not obliged to inform the buyer of changes, improvements or new developments or to make these available to him. A legally binding promise of certain qualities is not given. SecuTech is not responsible for damage unless it is the result of deliberate action or negligence on the part of SecuTech or its aids and assistants. SecuTech accepts no responsibility of any kind for indirect, accompanying or subsequent damage.

Contact Information

Web: http://www.esecutech.com

Email: [mailto:sales@eSecuTech.com sales@esecutech.com]

Please Email any comments, suggestions or questions regarding this document or our products to us at: [mailto:sales@eSecuTech.com sales@esecutech.com]

 
; CE Attestation of Conformity
[[File:CE Attestation.png|left|100px|top]]
: UniMate is in conformity with the protection requirements of CE Directives 89/336/EEC Amending Directive 92/31/EEC. UniMate satisfies the limits and verifying methods: EN55022/CISPR 22 Class B, EN55024: 1998.
 
; FCC Standard
[[File:FCC.png|left|100px|top]]
: This device is in conformance with Part 15 of the FCC Rules and Regulation for Information Technology Equipment.
: Operation of this product is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation.
 
[[File:USB Logo.png|left|100px|top]] The equipment of UniMate is USBbased.
 
; Conformity to ISO 9001<nowiki>:</nowiki>2000
[[File:ISO 9001.png|left|100px|top]]
: The Quality System of SecuTech Solution Inc., including its implementation, meets the requirements of the standard ISO 9001:2000
 
; ROHS
[[File:ROHS.png|left|100px|top]]
: All UniMate products are environmentally friendly with ROHS certificates.
 

==Introduction==
PKCS#11 is a Public-Key Cryptography Standard (PKCS) for public key cryptography, developed by RSA Laboratories and includes both algorithm-specific and algorithm-independent implementation standards. It is an industry standard that defines a technology independent programming interface for cryptographic devices such as smart cards and PCMCIA cards. This standard specifies an application program interface
(API) called Cryptoki (Cryptographic Token Interface), to devices, either physical or virtual, which hold cryptographic information (keys and other data) and perform cryptographic functions. This API is used across many platforms and is powerful enough for most security-related applications. SecuTech uses PKCS#11 as the main API for UniMate programming. UniMate supports PKCS#11 applications via UniMate middleware.

The following files are needed when developing UniMate PKCS#11 applications:

<table class="wikitable">
<tr>
<td style="background-color: red;">Files</td>
<td style="background-color: red;">Path</td>
</tr>
<tr>
<td>Cryptoki.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>pkcs11.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>Pkcs11f.h</td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>Pkcs11t.h/td>
<td>Provided by RSA</td>
</tr>
<tr>
<td>UniMateP11.dll / UniMateP11.so</td>
<td>SDK\PKCS#11\Libraries\</td>
</tr>
</table>

The PKCS#11 module of UniMate supports the creation of the following objects:

<table class="wikitable">
<tr>
<td style="background-color: red;">Object Class</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>CKO_DATA</td>
<td>For data structures defined by the application</td>
</tr>
<tr>
<td>CKO_SECRET_KEY</td>
<td>For symmetric keys</td>
</tr>
<tr>
<td>CKO_CERTIFICATE</td>
<td>For X.509 v3 certificates</td>
</tr>
<tr>
<td>CKO_PUBLIC_KEY</td>
<td>For RSA/DSA public key</td>
</tr>
<tr>
<td>CKO_PRIVATE_KEY</td>
<td>For RSA/DSA private key</td>
</tr>
</table>

All the objects listed in the above table can be created with UniMate. The secure storage in UniMate is limited, so objects can only be created in memory but can NOT be stored in the UniMate secure storage. Only encryption keys and permanently present data need to be saved in the UniMate.

==Supported PKCS#11 Algorithms and API==

<table class="wikitable" >
<tr>
<td style="background-color: red;">Algorithm</td>
<td style="background-color: red;">Encrypt/Decrypt</td>
<td style="background-color: red;">Sign/Verify</td>
<td style="background-color: red;">Digest</td>
<td style="background-color: red;">Generate key/pair</td>
</tr>
<tr>
<td>CKM_RSA_PKCS_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td>√</td>
</tr>
<tr>
<td>CKM_RSA_PKCS</td>
<td>√</td>
<td>√</td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DSA_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DSA</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_ECB</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_CBC</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC2_CBC_PAD</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC4_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_RC4</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>√</td>
</tr>
<tr>
<td>CKM_DES_ECB</td>
<td>√</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES_CBC</td>
<td>√</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>√</td>
</tr>
<tr>
<td>CKM_DES3_ECB</td>
<td>√</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_CBC</td>
<td>√</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_DES3_CBC_PAD</td>
<td>√</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_MD2</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_MD5</td>
<td></td>
<td></td>
<td>√</td>
<td></td>
</tr>
<tr>
<td>CKM_SHA_1</td>
<td></td>
<td></td>
<td>√</td>
<td></td>
</tr>
<tr>
<td>CKM_DH_PKCS_KEY_PAIR_GEN</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_AES_KEY_GEN</td>
<td></td>
<td></td>
<td></td>
<td>√</td>
</tr>
<tr>
<td>CKM_AES_CBC</td>
<td>√</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>CKM_AES_ECB</td>
<td>√</td>
<td></td>
<td></td>
<td></td>
</tr>
</table>

The table below lists all of the key sizes in the UniMate PKCS#11 library:

<table class="wikitable">
<tr>
<td style="background-color: red;">Algorithms</td>
<td style="background-color: red;">Key Sizes</td>
</tr>
<tr>
<td>CKM_RSA_PKCS_KEY_PAIR_GEN</td>
<td>1024bits, 2048bits</td>
</tr>
<tr>
<td>CKM_DES_KEY_GEN</td>
<td>64 bits</td>
</tr>
<tr>
<td>CKM_DES3_KEY_GEN</td>
<td>192 bits</td>
</tr>
<tr>
<td>CKM_AES_KEY_GEN</td>
<td>128 ～ 256 bits</td>
</tr>
</table>

[[#Table of Contents|CONTENTS]]
==UniMate PKCS#11 Function Library==
The UniMate PKCS#11 library only implements the standard PKCS#11 APIs. Any other APIs beyond PKCS#11 are not implemented. If such an API is called, an error return code such as CKR_FUNCTION_NO_SUPPORT will be returned.

<table class="wikitable">
<tr>
<td style="background-color: red;">Category</td>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Supported</td>
</tr>
<tr>
<td rowspan="4">General Purpose Function</td>
<td>C_Initialize</td>
<td>YES</td>
</tr>
<tr>
<td>C_Finalize</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetFunctionList</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="9">Slot and UniMate Management Function</td>
<td>C_GetSlotList</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetSlotInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetUniMateInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_WaitForSlotEvent</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetMechanismList</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetMechanismInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_InitUniMate</td>
<td>YES</td>
</tr>
<tr>
<td>C_InitPIN</td>
<td>YES</td>
</tr>
<tr>
<td>C_SetPIN</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="8">Session Management Function</td>
<td>C_OpenSession</td>
<td>YES</td>
</tr>
<tr>
<td>C_CloseSession</td>
<td>YES</td>
</tr>
<tr>
<td>C_CloseAllSessions</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetSessionInfo</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetOperationState</td>
<td>NO</td>
</tr>
<tr>
<td>C_SetOperationState</td>
<td>NO</td>
</tr>
<tr>
<td>C_Login</td>
<td>YES</td>
</tr>
<tr>
<td>C_Logout</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="9">Object Management Function</td>
<td>C_CreateObject</td>
<td>YES</td>
</tr>
<tr>
<td>C_CopyObject</td>
<td>NO</td>
</tr>
<tr>
<td>C_DestroyObject</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetObjectSize</td>
<td>YES</td>
</tr>
<tr>
<td>C_GetAttributeValue</td>
<td>YES</td>
</tr>
<tr>
<td>C_SetAttributeValue</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjectsInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjects</td>
<td>YES</td>
</tr>
<tr>
<td>C_FindObjectsFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="4">Encryption Function</td>
<td>C_EncryptInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Encrypt</td>
<td>YES</td>
</tr>
<tr>
<td>C_EncryptUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_EncryptFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="4">Decryption Function</td>
<td>C_DecryptInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Decrypt</td>
<td>YES</td>
</tr>
<tr>
<td>C_DecryptUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_DecryptFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="5">Message Digesting Function</td>
<td>C_DigestInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Digest</td>
<td>YES</td>
</tr>
<tr>
<td>C_DigestUpdate</td>
<td>YES</td>
</tr>
<tr>
<td>C_DigestKey</td>
<td>NO</td>
</tr>
<tr>
<td>C_DigestFinal</td>
<td>YES</td>
</tr>
<tr>
<td rowspan="6">Signing and Hashing Function (MAC)</td>
<td>C_SignInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Sign</td>
<td>YES</td>
</tr>
<tr>
<td>C_SignUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignFinal</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignRecoverInit</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignRecover</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="6">Functions for Verifying Signatures and Hashing (MAC)</td>
<td>C_VerifyInit</td>
<td>YES</td>
</tr>
<tr>
<td>C_Verify</td>
<td>YES</td>
</tr>
<tr>
<td>C_VerifyUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyFinal</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyRecoverInit</td>
<td>NO</td>
</tr>
<tr>
<td>C_VerifyRecover</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="4">Dual-Purpose Cryptographic Function</td>
<td>C_DigestEncryptUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_DecryptDigestUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_SignEncryptUpdate</td>
<td>NO</td>
</tr>
<tr>
<td>C_DecryptVerifyUpdate</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="5">Key Management Function</td>
<td>C_GenerateKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_GenerateKeyPair</td>
<td>YES</td>
</tr>
<tr>
<td>C_WrapKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_UnwrapKey</td>
<td>YES</td>
</tr>
<tr>
<td>C_DeriveKey</td>
<td>NO</td>
</tr>
<tr>
<td rowspan="2">Random Number Generation Function</td>
<td>C_SeedRandom</td>
<td>NO</td>
</tr>
<tr>
<td>C_GenerateRandom</td>
<td>YES</td>
</tr>
<tr>
<td>Callback Function</td>
<td></td>
<td>YES</td>
</tr>
</table>

[[#Table of Contents|CONTENTS]]
==Samples==
All the samples are implemented in C, and they all support PKCS#11 standard v.2.20. The samples are provided in: <code>SDK\PKCS#11\Sample</code>

<table class="wikitable">
<tr>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>C_Initialize</td>
<td>Initialize the PKCS#11 library</td>
</tr>
<tr>
<td>C_GetSlotList</td>
<td>Get the slot list</td>
</tr>
<tr>
<td>C_OpenSession</td>
<td>Open a session</td>
</tr>
<tr>
<td>C_Login</td>
<td>Log in</td>
</tr>
<tr>
<td>C_InitPIN</td>
<td>Initialize user PIN</td>
</tr>
<tr>
<td>C_Logout</td>
<td>Log out</td>
</tr>
<tr>
<td>C_FindObjectsInit</td>
<td>Initialize the search for any object</td>
</tr>
<tr>
<td>C_FindObjects</td>
<td>Find the objects which match</td>
</tr>
<tr>
<td>C_FindObjectsFinal</td>
<td>Cleanup the search</td>
</tr>
<tr>
<td>C_CloseSession</td>
<td>Close a session</td>
</tr>
<tr>
<td>C_GetAttributeValue</td>
<td>Get the attribute value</td>
</tr>
<tr>
<td>C_Finalize</td>
<td>Close PKCS #11 library</td>
</tr>
<tr>
<td>C_GenerateKeyPair</td>
<td>Generate a new public/private key pair</td>
</tr>
<tr>
<td>C_GenerateKey</td>
<td>Generate a secret key</td>
</tr>
<tr>
<td>C_WrapKey</td>
<td>Wrap (encrypt) a key</td>
</tr>
<tr>
<td>C_UnwrapKey</td>
<td>Unwrap (decrypt) a key</td>
</tr>
<tr>
<td>C_DeriveKey</td>
<td>Derive a key from a base key</td>
</tr>
<tr>
<td>C_SetPIN</td>
<td>Modify the current users PIN</td>
</tr>
<tr>
<td>C_GetTokenInfo</td>
<td>Get the slot information</td>
</tr>
<tr>
<td>C_SignInit</td>
<td>Initialize a signature</td>
</tr>
<tr>
<td>C_Sign</td>
<td>Sign data</td>
</tr>
<tr>
<td>C_SignUpdate</td>
<td>Continue a multiple-part signature</td>
</tr>
<tr>
<td>C_SignFinal</td>
<td>Finish a multiple-part signature</td>
</tr>
<tr>
<td>C_SignRecoverInit</td>
<td>Initialize a signature</td>
</tr>
<tr>
<td>C_SignRecover</td>
<td>Sign data, where the data can be recovered from the signature</td>
</tr>
<tr>
<td>C_DestroyObject</td>
<td>Destroy an object</td>
</tr>
<tr>
<td>C_GetFunctionList</td>
<td>Return the function list</td>
</tr>
<tr>
<td>C_GetMechanismList</td>
<td>Obtain a list of mechanism types</td>
</tr>
<tr>
<td>C_GetMechanismInfo</td>
<td>Obtain information about a particular mechanism possibly supported by a token</td>
</tr>
<tr>
<td>C_InitToken</td>
<td>Initialize a token</td>
</tr>
<tr>
<td>C_GetSessionInfo</td>
<td>Obtain information about the session</td>
</tr>
<tr>
<td>C_GetOperationState</td>
<td>Obtain the cryptographic state of a session</td>
</tr>
<tr>
<td>C_SetOperationState</td>
<td>Restore the cryptographic state of a session</td>
</tr>
<tr>
<td>C_EncryptInit</td>
<td>Initialize an encryption operation</td>
</tr>
<tr>
<td>C_Encrypt</td>
<td>Encrypt single-part data</td>
</tr>
<tr>
<td>C_EncryptUpdate</td>
<td>Continue a multiple-part encryption</td>
</tr>
<tr>
<td>C_EncryptFinal</td>
<td>Finish a multiple-part encryption operation</td>
</tr>
<tr>
<td>C_DecryptInit</td>
<td>Initialize a decryption</td>
</tr>
<tr>
<td>C_Decrypt</td>
<td>Decrypt encrypted data in a single part</td>
</tr>
<tr>
<td>C_DecryptUpdate</td>
<td>Continue a multiple-part decryption</td>
</tr>
<tr>
<td>C_DecryptFinal</td>
<td>Finish a multiple-part decryption</td>
</tr>
<tr>
<td>C_DigestInit</td>
<td>Initialize a message-digesting operation.</td>
</tr>
<tr>
<td>C_Digest</td>
<td>Digest data in a single part</td>
</tr>
<tr>
<td>C_DigestUpdate</td>
<td>Continue a multiple-part message-digesting</td>
</tr>
<tr>
<td>C_DigestFinal</td>
<td>Finish a multiple-part message-digesting</td>
</tr>
<tr>
<td>C_VerifyInit</td>
<td>Initialize a verification</td>
</tr>
<tr>
<td>C_Verify</td>
<td>Verify a signature</td>
</tr>
<tr>
<td>C_VerifyUpdate</td>
<td>Continue a multiple-part verification</td>
</tr>
<tr>
<td>C_VerifyFinal</td>
<td>Finish a multiple-part verification</td>
</tr>
<tr>
<td>C_VerifyRecoverInit</td>
<td>Initialize a signature verification</td>
</tr>
<tr>
<td>C_VerifyRecover</td>
<td>Verify a signature, where the data is recovered from the signature</td>
</tr>
<tr>
<td>C_SeedRandom</td>
<td>Mix additional seed material into the token's random number generator</td>
</tr>
<tr>
<td>C_GenerateRandom</td>
<td>Generate random data</td>
</tr>
<tr>
<td>C_GetFunctionStatus</td>
<td>Obtain an updated status of a function running in parallel with an application</td>
</tr>
<tr>
<td>C_CancelFunction</td>
<td>Cancel a function</td>
</tr>
<tr>
<td>C_WaitForSlotEvent</td>
<td>Wait for a slot event to occur</td>
</tr>
</table>

 
If you have any questions, please feel free to contact us at: http://www.esecutech.com/support or [mailto:support@esecutech.com support@esecutech.com]

 
{| style="border-style: solid; border-width: 1px;" align="center"
|
<gallery class="center" mode="nolines" widths=175px heights=50px caption="Follow Us!">
File:Twitter.png|'''[https://twitter.com/eSecuTech Twitter]'''
File:Facebook.png|'''[https://www.facebook.com/eSecuTech/ Facebook]'''
File:YouTube.png|'''[https://www.youtube.com/user/esecutech YouTube]'''
File:Linked In.png|'''[https://ca.linkedin.com/in/secutech-solutions-inc-39110b25 LinkedIn]'''
</gallery>
|}

 
[[File:Footer Logo List.png|left]]
 
About SecuTech

SecuTech Solution Inc. is a company specializing in data protection and strong authentication, providing total customer satisfaction in security systems & services for banks, financial institutions & other industries. Having extensive and in-depth experience within the information security market, SecuTech has drawn upon this experience to utilize today's cutting-edge technologies that are effective against increasingly sophisticated cyber attacks. Enabling enterprises, financial institutions, and government to safely adopt the economic benefits of mobile and cloud computing.

http://www.esecutech.com SecuTech Solution Inc.

{| class="wikitable"
|+ style="text-align:left;" | Contact Us:
!
! scope="col"| North America
! scope="col"| China
! scope="col"| Asia-Pacific
! scope="col"| EMEA
|-
! scope="row"| Address
| 1250 Boulevard Ren-Lvesque Ouest, #2200, Montreal, QC, H3B 4W8, Canada
| Level 12, #67 Bei Si Huan Xi Lu, Beijing, China, 100080
| Suite 5.14, 32 Delhi Rd, North Ryde, NSW, 2113, Australia
| 4 Cours Bayard 69002 Lyon, France
|-
! scope="row"| Phone
| +1 -888-259-5825
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Fax
| +1 -888-259-5825 ext.0
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Email
| [mailto:info@esecutech.com info@esecutech.com]
| [mailto:cn@esecutech.com cn@esecutech.com]
| [mailto:aus@esecutech.com aus@esecutech.com]
| [mailto:europe@esecutech.com europe@esecutech.com]
|}

Copyright 2012 SecuTech Solution Inc. All rights reserved. Reproduction in whole or in part without written permission from SecuTech is prohibited. SecuTech UniMate and the SecuTech logo are trademarks of SecuTech Inc. Windows and all other trademarks are properties of their respective owners. Features and specifications are subject to change without notice.

[[File:SecuTech Logo.png]]

 
[[#top|TOP]]

UniMate USB CSP Manual

2016-06-30T03:17:53Z

Administrator:

[[category:UniMate Manuals]]

<div id = "Table of Contents"></div>
==CSP Manual==

Version 2.0

<table class="wikitable">
<tr>
<td style="background-color: red;">Version</td>
<td style="background-color: red;">Date</td>
</tr>
<tr>
<td>1.0</td>
<td>2015.7</td>
</tr>
<tr>
<td>2.0</td>
<td>2016.7</td>
</tr>
</table>

The data and information contained in this document cannot be altered without the express written permission of SecuTech Solution Inc. No part of this document can be reproduced or transmitted for any purpose whatsoever, either by electronic or mechanical means.

The general terms of trade of SecuTech Solution Inc. apply. Diverging agreements must be made in writing.

Copyright SecuTech Solution Inc. All rights reserved.

WINDOWS is a registered trademark of Microsoft Corporation.

The WINDOWS-logo is a registered trademark (TM) of Microsoft Corporation.

Software License

The software and the enclosed documentation are copyright-protected. By installing the software, you agree to the conditions of the licensing agreement.

Licensing Agreement

SecuTech Solution Inc. (SecuTech for short) gives the buyer the simple, exclusive and non-transferable licensing right to use the software on one individual computer or networked computer system (LAN). Copying and any other form of reproduction of the software in full or in part as well as mixing and linking it with others is prohibited. The buyer is authorized to make one single copy of the software as backup. SecuTech reserves the right to change or improve the software without notice or to replace it with a new development. SecuTech is not obliged to inform the buyer of changes, improvements or new developments or to make these available to him. A legally binding promise of certain qualities is not given. SecuTech is not responsible for damage unless it is the result of deliberate action or negligence on the part of SecuTech or its aids and assistants. SecuTech accepts no responsibility of any kind for indirect, accompanying or subsequent damage.

Contact Information

Web: http://www.esecutech.com

Email: [mailto:sales@eSecuTech.com sales@esecutech.com]

Please Email any comments, suggestions or questions regarding this document or our products to us at: [mailto:sales@eSecuTech.com sales@esecutech.com]

 
; CE Attestation of Conformity
[[File:CE Attestation.png|left|100px|top]]
: UniMate is in conformity with the protection requirements of CE Directives 89/336/EEC Amending Directive 92/31/EEC. UniMate satisfies the limits and verifying methods: EN55022/CISPR 22 Class B, EN55024: 1998.
 
; FCC Standard
[[File:FCC.png|left|100px|top]]
: This device is in conformance with Part 15 of the FCC Rules and Regulation for Information Technology Equipment.
: Operation of this product is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation.
 
[[File:USB Logo.png|left|100px|top]] The equipment of UniMate is USBbased.
 
; Conformity to ISO 9001<nowiki>:</nowiki>2000
[[File:ISO 9001.png|left|100px|top]]
: The Quality System of SecuTech Solution Inc., including its implementation, meets the requirements of the standard ISO 9001:2000
 
; ROHS
[[File:ROHS.png|left|100px|top]]
: All UniMate products are environmentally friendly with ROHS certificates.
 

==Introduction==

CAPI (Cryptographic Application Programming Interface), developed by Microsoft as part of Microsoft Windows, is an interface to a library of functions software developers can call upon for security and cryptography services. It is intended for use by developers of applications for MS Windows platforms.

CAPI allows multiple cryptographic service providers (CSP) to coexist on the same computer and to be used in the same application. It is also possible to associate a CSP with a particular smartcard, so that smartcard-enabled Windows applications will call the correct CSP. MS Windows contains many helper functions that application developers may use to simplify code when working with cryptographic functions or with complicated data structures (such as certificates).

Choosing which API to use when developing applications is dependent on the needs of the particular application.

==Algorithms and APIs==

<table class="wikitable">
<tr >
<td style="background-color: red;" colspan="2">Connection functions</td>
</tr>
<tr>
<td>CryptAcquireContext</td>
<td>Create a context and initialize access to CSP which must be specified</td>
</tr>
<tr>
<td>CryptReleaseContext</td>
<td>Release the context created in CryptAcquireContext and other resources</td>
</tr>
<tr>
<td>CryptGetProvParam</td>
<td>Return information related to CSP</td>
</tr>
<tr>
<td>CryptSetProvParam</td>
<td>Set parameters of CSP</td>
</tr>
<tr >
<td style="background-color: red;" colspan="2">Generate and exchange key functions</td>
</tr>
<tr>
<td>CryptGenKey</td>
<td>Generate key or key pair</td>
</tr>
<tr>
<td>CryptDeriveKey</td>
<td>Derive a session key from a data hash and guarantee the generated key difference</td>
</tr>
<tr>
<td>CryptSetKeyParam</td>
<td>Set key attributes</td>
</tr>
<tr>
<td>CryptGetKeyParam</td>
<td>Retrieves the data that controls the operations of the key</td>
</tr>
<tr>
<td>CryptExportKey</td>
<td>Export key from container</td>
</tr>
<tr>
<td>CryptImportKey</td>
<td>Import the key to CSP container</td>
</tr>
<tr>
<td>CryptDestroyKey</td>
<td>Release key handle, after which the handle will be invalid and cannot be accessed</td>
</tr>
<tr>
<td>CryptDuplicateKey</td>
<td>Create a duplicate of the key</td>
</tr>
<tr>
<td>CryptGenRandom</td>
<td>Generate random data</td>
</tr>
<tr>
<td>CryptGetUserKey</td>
<td>Gets a handle to a permanent user key</td>
</tr>
<tr >
<td style="background-color: red;" colspan="2">Data encryption function</td>
</tr>
<tr>
<td>CryptDecrypt</td>
<td>Decrypt document</td>
</tr>
<tr>
<td>CryptEncrypt</td>
<td>Encrypt document</td>
</tr>
<tr>
<td>CryptCreateHash</td>
<td>Returns a handle to a created hashing object and initializes it</td>
</tr>
<tr>
<td>CryptDestroyHash</td>
<td>Delete hashing object handle</td>
</tr>
<tr>
<td>CryptDuplicateHash</td>
<td>Duplicates a hashing object, including state, up to when the duplication is done</td>
</tr>
<tr>
<td>CryptHashData</td>
<td>Hash input data</td>
</tr>
<tr>
<td>CryptGetHashParam</td>
<td>Get the hash value and data that control the operations of the hash object</td>
</tr>
<tr>
<td>CryptHashSessionKey</td>
<td>Hash a session key without revealing the key value to the application</td>
</tr>
<tr>
<td>CryptSetHashParam</td>
<td>Set the attributes of a hash object, such as specific algorithm or initial contents</td>
</tr>
<tr>
<td>CryptSignHash</td>
<td>Sign a hash object</td>
</tr>
<tr>
<td>CryptVerifySignature</td>
<td>Verifies the signature of a hash object</td>
</tr>
</table>

[[#Table of Contents|CONTENTS]]
==Samples==
All the samples are implemented in the C++ language, and they all support the MS-CAPI standard. We provide the samples below, located in path: <code>SDK\CSP(MS-CAPI)\Sample</code>

<table class="wikitable">
<tr>
<td style="background-color: red;">Function</td>
<td style="background-color: red;">Files</td>
<td style="background-color: red;">Description</td>
</tr>
<tr>
<td>Algorithm</td>
<td>algorithmTest.cpp algorithmTest.h</td>
<td>This sample demonstrates operations on symmetric keys, hashing and asymmetric keys.</td>
</tr>
<tr>
<td>Container</td>
<td>kcsTest.cpp kcsTest.h</td>
<td>This sample demonstrates enumeration, deletion and creation of files.</td>
</tr>
<tr>
<td>Certificates</td>
<td>listcerts.cpp listcerts.h</td>
<td>This sample demonstrates operations on a certificate list.</td>
</tr>
</table>

===Algorithm samples===
These samples include 3 functions:
* <code>int GenerateAlgTest(ULONG ulALG)</code>
* <code>int DeviceAlgTest(ULONG ulALG)</code>
* <code>int RstTest(ULONG version)</code>

GenerateAlgTest is used for DES key generation, encryption and decryption operations:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Create a container</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. Retrieve parameters that govern the operations of a CSP</td>
<td>CryptGetProvParam</td>
</tr>
<tr>
<td>3. Generate a key</td>
<td>CryptGenKey</td>
</tr>
<tr>
<td>4. Data Encryption</td>
<td>CryptEncrypt</td>
</tr>
<tr>
<td>5. Data Decryption</td>
<td>CryptDecrypt</td>
</tr>
</table>

DeviceAlgTest is used for key derivation, data encryption and decryption operations:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Create a container</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. Initiate the hashing of a stream of data</td>
<td>CryptCreateHash</td>
</tr>
<tr>
<td>3. Add data to a specified hash object</td>
<td>CryptHashData</td>
</tr>
<tr>
<td>4. Derive a key</td>
<td>CryptDeriveKey</td>
</tr>
<tr>
<td>5. Data Encryption</td>
<td>CryptEncrypt</td>
</tr>
<tr>
<td>6. Data Decryption</td>
<td>CryptDecrypt</td>
</tr>
</table>

RstTest is used for RSA key generation, data encryption and decryption operations:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Create a container</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. Generate a key</td>
<td>CryptGenKey</td>
</tr>
<tr>
<td>3. Data Encryption</td>
<td>CryptEncrypt</td>
</tr>
<tr>
<td>4. Data Decryption</td>
<td>CryptDecrypt</td>
</tr>
</table>

===Container sample===
This sample demonstrates how to enumerate, add and delete containers with the function - <code>int kcsTest(ULONG ulActive)</code>

For enumerating a container: 

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Acquire a "VERIFYCONTEXT" handle</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. Enumerate through the key containers</td>
<td>CryptGetProvParam</td>
</tr>
<tr>
<td>3. Acquire a handle to the key container found</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>4. Try to get a handle to the key pair</td>
<td>CryptGetUserKey</td>
</tr>
<tr>
<td>5. Get key permissions</td>
<td>CryptGetKeyParam</td>
</tr>
<tr>
<td>6. Display key permissions</td>
<td></td>
</tr>
</table>

For adding a container:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Check whether the container already exists</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. If not, create a container</td>
<td>CryptAcquireContext</td>
</tr>
</table>

For deleting a container:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Check whether the container already exists</td>
<td>CryptAcquireContext</td>
</tr>
<tr>
<td>2. If it does, release the handle to the context</td>
<td>CryptReleaseContext</td>
</tr>
<tr>
<td>3. Delete the container</td>
<td>CryptAcquireContext</td>
</tr>
</table>

===List Certificate sample===
This sample demonstrates how to enumerate certificates with the function - <code>int listcerts(void)</code>

For enumerating certificates:

<table class="wikitable">
<tr>
<td style="background-color: red;">Steps</td>
<td style="background-color: red;">Function</td>
</tr>
<tr>
<td>1. Open a handle to the certificate store: MY\\UniMateStore</td>
<td>CertOpenStore</td>
</tr>
<tr>
<td>2. Go over each and every certificate within the certificate store</td>
<td>CertEnumCertificatesInStore</td>
</tr>
<tr>
<td>3. Get and display the subject name from the certificate</td>
<td>CertGetNameString</td>
</tr>
</table>

[[#Table of Contents|CONTENTS]]
==PKI package==
UniMate provides a PKI package for developers and end users respectively. The package provides the UniMate PKI installation, if you want to use the PKI package, you must install it.

===Installation===
The UniMate PKI package can be found in the redists folder of the SDK.

For the developer package, double click the icon to run PKI package.exe, and follow the instructions below:

Click Install.

[[File:UniMate PKI Setup.PNG]]

 
Afterwards, click Finish to close the setup wizard.

[[File:UniMate PKI Finish.PNG]]

===Uninstallation===
To uninstall the software, select <code>Start Menu -- All apps -- UniMate Drive\PKI package\uninstall</code> (on Windows 8/10 you may need to right-click the file in the folder, mouse over More and select Open file location). Otherwise, by default the uninstaller is located in: <code>C:\Users\<your_username>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\UniMate Drive\PKI package</code>

Click OK and restart your computer to finish the uninstallation.

[[File:UniMate PKI Uninstall.PNG]]

 
If you have any questions, please feel free to contact us at: http://www.esecutech.com/support or [mailto:support@esecutech.com support@esecutech.com]

 
{| style="border-style: solid; border-width: 1px;" align="center"
|
<gallery class="center" mode="nolines" widths=175px heights=50px caption="Follow Us!">
File:Twitter.png|'''[https://twitter.com/eSecuTech Twitter]'''
File:Facebook.png|'''[https://www.facebook.com/eSecuTech/ Facebook]'''
File:YouTube.png|'''[https://www.youtube.com/user/esecutech YouTube]'''
File:Linked In.png|'''[https://ca.linkedin.com/in/secutech-solutions-inc-39110b25 LinkedIn]'''
</gallery>
|}

 
[[File:Footer Logo List.png|left]]
 
About SecuTech

SecuTech Solution Inc. is a company specializing in data protection and strong authentication, providing total customer satisfaction in security systems & services for banks, financial institutions & other industries. Having extensive and in-depth experience within the information security market, SecuTech has drawn upon this experience to utilize today's cutting-edge technologies that are effective against increasingly sophisticated cyber attacks. Enabling enterprises, financial institutions, and government to safely adopt the economic benefits of mobile and cloud computing.

http://www.esecutech.com SecuTech Solution Inc.

{| class="wikitable"
|+ style="text-align:left;" | Contact Us:
!
! scope="col"| North America
! scope="col"| China
! scope="col"| Asia-Pacific
! scope="col"| EMEA
|-
! scope="row"| Address
| 1250 Boulevard Ren-Lvesque Ouest, #2200, Montreal, QC, H3B 4W8, Canada
| Level 12, #67 Bei Si Huan Xi Lu, Beijing, China, 100080
| Suite 5.14, 32 Delhi Rd, North Ryde, NSW, 2113, Australia
| 4 Cours Bayard 69002 Lyon, France
|-
! scope="row"| Phone
| +1 -888-259-5825
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Fax
| +1 -888-259-5825 ext.0
| +8610-8288 8834
| 00612-9888 6185
| +33-042-600-2810
|-
! scope="row"| Email
| [mailto:info@esecutech.com info@esecutech.com]
| [mailto:cn@esecutech.com cn@esecutech.com]
| [mailto:aus@esecutech.com aus@esecutech.com]
| [mailto:europe@esecutech.com europe@esecutech.com]
|}

Copyright 2012 SecuTech Solution Inc. All rights reserved. Reproduction in whole or in part without written permission from SecuTech is prohibited. SecuTech UniMate and the SecuTech logo are trademarks of SecuTech Inc. Windows and all other trademarks are properties of their respective owners. Features and specifications are subject to change without notice.

[[File:SecuTech Logo.png]]

 
[[#top|TOP]]

Main Page

2016-06-30T03:17:22Z

Administrator:

'''Welcome to the SecuTech Wiki'''

Information on our products and viewable manuals and guides are available on our Wiki.

Please note this Wiki is currently under construction and is continually updated.

 

{| cellspacing="0" cellpadding="0" border="0" style="width: 728px; height: 247px;"
|-valign="top"
|
'''UniKey [Software Protection]'''

- [[:category:UniKey Application Solutions|UniKey Application Solutions]]

- [[:category:UniKey Library Integration Guides|UniKey Library Integration Guides]]

- [[:category:UniKey Tools|UniKey Tools]]

- [[:category:UniKey API|UniKey API Reference]]

- [[:category:UniKey Hardware Troubleshooting|UniKey Hardware Troubleshooting Guide]]

- [[:category:UniKey FAQ|UniKey Frequently Asked Questions]]

- [http://files.esecutech.com/marketing-materials/ProductsDoc/UniKey/UniKeyQuickStartGuide-2015.pdf UniKey Quick Start Guide]

- [[:category:UniKey Gallery|UniKey Gallery]]
|
'''UniToken [USB Authentication]'''

- [[:category:UniToken Integration Guide|UniToken Integration Guide]]

- [[:category:UniToken Tools|UniToken Tools]]

- [[:category:UniToken API|UniToken API Reference]]

- [[:category:UniToken Hardware Troubleshooting|UniToken Hardware Troubleshooting Guide]]

- [[:category:UniToken FAQ|UniToken Frequently Asked Questions]]

- [http://files.esecutech.com/marketing-materials/ProductsDoc/UniToken/UniToken_quickstart-130827EN.pdf UniToken Quick Start Guide]

- [[:category:UniToken Gallery|UniToken Gallery]]

|-valign="top"
|
'''UniOTP [One-time Password]'''

- [[:category:UniOTP Integration Solutions|UniOTP Integration Solutions]]

- [[:category:UniOTP Tools|UniOTP Tools]]

- [[:category:UniOTP API|UniOTP API Reference]]

- [[:category:UniOTP FAQ|UniOTP Frequently Asked Questions]]

- [[:category:UniOTP Gallery|UniOTP Gallery]]

 

|
'''UniMate [Mobile Authentication]'''

- [[:category:UniMate|UniMate Documentation]]

- [[:category:UniMate Manuals|UniMate Manuals]]

- [[:category:UniMate Family|UniMate Family]]

- [[:category:UniMate API|UniMate API Reference]]

- [[:category:UniMate FAQ|UniMate Frequently Asked Questions]]

- [[:category:UniMate Gallery|UniMate Gallery]]

|

|-valign="top"
|
'''Resources'''

- [[:category:Resources|Resources]]

|}