Crescendo SDK
Loading...
Searching...
No Matches
CrescendoDLL Namespace Reference

Namespaces

namespace  Fido
 
namespace  PCSC
 
namespace  Platform
 
namespace  USB_HID
 

Classes

class  Logger
 Logging class for logging messages with chosen severity. More...
 
class  SDKCore
 The SDKCore class contains all fundamental methods that can be used by the user to communicate with the SmartCard. More...
 
class  Token
 Unified description of a single token/authenticator the SDK can drive. Combines Crescendo PC/SC tokens (full applet stack — ACA / OATH / PIV / CardManager / FIDO) with generic FIDO authenticators reachable over USB-HID or PC/SC NFC. More...
 
class  TokenChange
 Describes one delta between two CrescendoDLL.TokenManager snapshots. More...
 
class  TokenDiscovery
 One-shot enumeration of every CrescendoDLL.Token the SDK can drive in the current snapshot — Crescendo PC/SC tokens (full applet stack) and generic FIDO authenticators reachable over USB-HID or PC/SC NFC. More...
 
class  TokenManager
 Continuously monitors every CrescendoDLL.Token the SDK can drive - both Crescendo PC/SC tokens (full applet stack) and generic FIDO authenticators reachable over USB-HID or PC/SC NFC - and emits a single event stream covering hot-plug and card insertion/removal. More...
 

Enumerations

enum  DataType {
  BIN , HEX , BASE64 , BASE64URL ,
  UTF8
}
 Enum representing the different data types that can be converted to a byte array. More...
 
enum  DeviceMonitoringStatus {
  Stopped , Healthy , Degraded , Failed ,
  Recovering
}
 Health of CrescendoDLL.TokenManager's composite watchers (PC/SC reader changes, HID hot-plug, PC/SC service availability). More...
 
enum  LogLevel {
  DEBUG , INFO , WARN , ERROR ,
  SILENT
}
 Enumeration representing different levels of logging. More...
 
enum  TokenChangeKind { Added , Updated , Removed }
 Type of change detected by CrescendoDLL.TokenManager between two CrescendoDLL.Token snapshots. More...
 

Enumeration Type Documentation

◆ DataType

Enum representing the different data types that can be converted to a byte array.

Enumerator
BIN 

Binary data format. Used only when bytes should be read directly from a given file.

HEX 

Hexadecimal string, where every two characters represent a byte.

BASE64 

Base64 string, which can be directly converted to a byte array.

BASE64URL 

Base64 URL string, which can be directly converted to a byte array.

UTF8 

UTF8 string, where each character is converted to its UTF8 value to form a byte array.

◆ DeviceMonitoringStatus

Health of CrescendoDLL.TokenManager's composite watchers (PC/SC reader changes, HID hot-plug, PC/SC service availability).

Enumerator
Stopped 

Monitoring is not running. CrescendoDLL.TokenManager.StartMonitoring has not been called, or CrescendoDLL.TokenManager.StopMonitoring was called.

Healthy 

All watchers (PC/SC + HID) are operating normally.

Degraded 

At least one watcher failed but at least one other is still working. For example, the PC/SC service stopped while HID hot-plug remains active.

Failed 

All watchers failed. No live device events will be delivered until the situation recovers.

Recovering 

A previously failed watcher is being re-initialised after a transient error (e.g. PC/SC service restarted).

◆ LogLevel

Enumeration representing different levels of logging.

Enumerator
DEBUG 

Log detailed diagnostic information. This level includes raw APDU commands and responses, complete USB HID (CTAP) packet dumps, and granular step-by-step protocol traces. Ideal for in-depth troubleshooting. (Note: sensitive data within payloads is redacted by default).

INFO 

Log high-level informational messages and confirmations that operations are proceeding as expected. Includes user prompts (e.g., "Please press the button on the device") and general token/reader enumeration results.

WARN 

Log an indication that something unexpected happened, but the SDK is able to recover or safely continue. Examples include unexpected device responses, missing optional data objects, or non-fatal protocol mismatches.

ERROR 

Log severe issues where the SDK has failed to perform a requested operation. Examples include critical PC/SC or HID communication failures, trapped exceptions, or unsupported hardware capabilities.

SILENT 

Fully suppresses all log output. This is the recommended setting when consuming the SDK programmatically or when relying on pure data output (e.g., raw JSON) to standard output.

◆ TokenChangeKind

Type of change detected by CrescendoDLL.TokenManager between two CrescendoDLL.Token snapshots.

Enumerator
Added 

A new CrescendoDLL.Token appeared (card inserted, USB authenticator plugged in, etc.).

Updated 

An existing CrescendoDLL.Token stayed present but materially changed (for example, a composite device gained its USB-HID FIDO interface after first being seen only via PC/SC).

Removed 

An existing CrescendoDLL.Token disappeared (card removed, authenticator unplugged, etc.).