1-Wire API for .NET Version 4.00
Public Member Functions | Protected Member Functions | Protected Attributes | Static Package Attributes

SHAiButtonUser Class Reference

Inherited by SHAiButtonUser18, and SHAiButtonUser33.

List of all members.

Public Member Functions

int getAccountPageNumber ()
String getAccountFilename ()
byte[] getAddress ()
void getAddress (byte[] data, int offset)
void getAddress (byte[] data, int offset, int cnt)
void setForceOverdrive (boolean value)
 Sets whether or not the container should be forced into overdrive.
boolean getForceOverdrive ()
 Reports whether or not the container is forced into overdrive.

Protected Member Functions

boolean createServiceFile (OneWireContainer owc, String filename, boolean formatDevice)

Protected Attributes

byte[] address = null
 Cache of 1-Wire Address.
final byte[] accountData = new byte[32]
 local cache of accountData
int accountPageNumber = -1
 page number account data is stored on
final byte[] serviceFile
 used to construct appropriate string for OWFile constructor
String strServiceFilename = null
 stores string name of user's service file
final byte[] fullBindCode = new byte[15]
 maintains a cache of the fullBindCode, for later binding of coprocessor.
int writeCycleCounter = -1
 local cache of writeCycleCounter for data page
boolean forceOverdrive = false
 force 1-wire container into overdrive speed

Static Package Attributes

static final boolean DEBUG = false
 Turns on extra debugging output.

Detailed Description

The abstract superclass for all users of a SHAiButton transaction system. The user in a SHA transaction system mainly consists of a page (or pages) of account data. The abstract superclass guarantees an interface for retrieving information about account data, as well as reading and writing that data.

SHAiButtonUser was defined for use with the DS1963S (family code 0x18) and the DS1961S (family code 0x33). The benefit to using our SHA iButtons in a transaction is for device authentication. Using a challenge-response protocol, the DS1961S and the DS1963S can authenticate themselves to the system before their actual account data is verified. But, if device authentication isn't important to your transaction, the SHAiButtonUser can be extended to support any 1-Wire memory device.

The format of user's account data is not specified by this class, only the interface for accessing it. Each different SHATransaction is free to implement whatever format is appropriate for the transaction type.

See also:
SHATransaction
SHAiButtonCopr
SHAiButtonUser18
SHAiButtonUser33
Version:
1.00
Author:
SKH

Member Function Documentation

boolean createServiceFile ( OneWireContainer  owc,
String  filename,
boolean  formatDevice 
) [protected]

Create's empty service file for the user with the given filename. Also, it populates accountPageNumber with the page that the service file is stored on.

Parameters:
owcthe 1-wire device where the service file will be created.
filenamethe filename of the service file.
formatDeviceif true, the device is formatted before creating the service file.

Asserts that proper account info exists for this SHAiButtonUser and establishes a buffer for caching account data.

Parameters:
ibcthe OneWireContainer whose account info is checked
Returns:
whether or not the device is initialized properly

Modifies this SHA iButton so that it refers to another device. If this object already has an appropriate instance of OneWireContainer, that instance is updated with the new address.

Parameters:
adapterThe adapter that the device can be found on.
addressThe address of the 1-Wire device
Returns:
true if a valid account service file exists on this OneWireContainer18.
Exceptions:
OneWireIOExceptionon a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireExceptionon a communication or setup error with the 1-Wire adapter

Modifies this SHA iButton so that it refers to another device. If this object does not already has an appropriate instance of OneWireContainer, it returns false immediately, because there is no adapter info available. Otherwise, it reuses the same adapter.

Parameters:
addressThe address of the 1-Wire device
Returns:
true if a valid account service file exists on this OneWireContainer18.
Exceptions:
OneWireIOExceptionon a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireExceptionon a communication or setup error with the 1-Wire adapter

Returns the value of the write cycle counter for the page where the account data is stored. If the write cycle counter has ever been retrieved, this returns the cached value. Otherwise, this method reads the value from the part.

For devices that do not support write cycle counters, this method always returns -1.

Returns:
the value of the write cycle counter for the account data page.
Exceptions:
OneWireIOExceptionon a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireExceptionon a communication or setup error with the 1-Wire adapter

Returns true if this buttons account data is stored on a page that has a write cycle counter.

Returns:
true if account page has write cycle counter.

This function creates the full 15-byte binding data for the coprocessor to use to recreate this user's secret on the copr's workspace page. This function is located in the SHAiButtonUser class to support binding codes for user buttons who use alternate techniques (such as the DS1961S) for secret computation.

Parameters:
bindCodethe 7-byte binding code from coprocessor's service file
fullBindCodethe 15-byte full binding code to to be copied into the coprocessor's scratchpad. There should be 15 bytes available starting from the offset.
offsetthe offset into fullBindCode where copying should begin.

Returns a byte representing the appropriate authorization command for the coprocessor to use to authenticate this user. For a DS1961S, the authentication command is AUTH_HOST, but for a DS1963S, the authentication command is VALIDATE_PAGE.

Returns:
byte indicating appropriate command for authenticating user

Writes the account data to the SHAiButton. First, this function asserts that the account page number is known. The account data is copied from dataBuffer starting at the offset. If there are less than 32 bytes available to copy, this function only copies the bytes that are available.

Parameters:
dataBufferthe buffer to copy the account data from
offsetthe index into the buffer where copying should begin
Returns:
whether or not the data write succeeded
Exceptions:
OneWireIOExceptionon a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireExceptionon a communication or setup error with the 1-Wire adapter

Reads the account data off the SHAiButton using a standard READ command. First, this function asserts that the account page number is known as well as the length of the account file. The 32 byte account data page is copied into dataBuffer starting at the given offset.

Parameters:
dataBufferthe buffer to copy the account data into
offsetthe index into the buffer where copying should begin
Returns:
whether or not the read was successful
Exceptions:
OneWireIOExceptionon a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireExceptionon a communication or setup error with the 1-Wire adapter

Reads the account data off the SHAiButton using a READ_AUTHENTICATE command. First, this function asserts that the account page number is known as well as the length of the account file. Then it copies the 3 byte challenge to the scratchpad before sending the command for READ_AUTHENTICATE. The 32 byte account data page is copied into dataBuffer starting at dataStart.

In addition to the account data, this function also returns a calculated MAC. The MAC requires 20 bytes after the start index. The return value is the write cycle counter value for the account data page

Parameters:
chlgthe buffer containing a 3-byte random challenge.
chlgStartthe index into the buffer where the 3 byte challenge begins.
dataBufferthe buffer to copy the account data into
dataStartthe index into the buffer where copying should begin
macthe buffer to copy the resulting Message Authentication Code
macStartthe index into the mac buffer to start copying
Returns:
the value of the write cycle counter for the page
Exceptions:
OneWireIOExceptionon a 1-Wire communication error such as reading an incorrect CRC from a 1-Wire device. This could be caused by a physical interruption in the 1-Wire Network due to shorts or a newly arriving 1-Wire device issuing a 'presence pulse'.
OneWireExceptionon a communication or setup error with the 1-Wire adapter

Refreshes eeprom SHA devices in case of weakly-programmed bits on the account page.

Returns:
true if the refresh was successful

Returns a string representing this SHAiButton.

Returns:
a string containing the 8-byte address of this 1-Wire device.

String getAccountFilename ( )

Returns the TMEX filename of the user's account data file.

Returns:
filename of user's account data file
int getAccountPageNumber ( )

Returns the page number of the first memory page where account data is stored.

Returns:
page number where account data is stored.
void getAddress ( byte[]  data,
int  offset 
)

Copies the 8 byte address of the OneWireContainer into the provided array starting at the given offset.

Parameters:
dataarray with at least 8 bytes after offset
offsetthe index at which copying starts
void getAddress ( byte[]  data,
int  offset,
int  cnt 
)

Copies the specified number of bytes from the address of the OneWireContainer into the provided array starting at the given offset.

Parameters:
dataarray with at least cnt bytes after offset
offsetthe index at which copying starts
cntthe number of bytes to copy
byte [] getAddress ( )

Returns the 8 byte address of the OneWireContainer this SHAiButton refers to.

Returns:
8 byte array containing family code, address, and crc8 of the OneWire device.
boolean getForceOverdrive ( )

Reports whether or not the container is forced into overdrive.

Returns:
if true, the container will be forced to overdrive
void setForceOverdrive ( boolean  value)

Sets whether or not the container should be forced into overdrive.

Parameters:
valueif true, the container will be forced to overdrive

The documentation for this class was generated from the following file: