SecureBlackbox 2020 macOS Edition

Questions / Feedback?

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

associatedData
Data

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

basePath
String

Base path for this user in the server's file system.

cert
Data

Contains the user's certificate.

data
String

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

handle
Int64

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

hashAlgorithm
String

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

SB_MAC_ALGORITHM_HMAC_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

incomingSpeedLimit
Int32

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

otpAlgorithm
OTPAlgorithms

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

oaHmac0
oaTime1

otpValue
Int32

The user's time interval (TOTP) or Counter (HOTP).

outgoingSpeedLimit
Int32

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

password
String

The user's authentication password.

passwordLen
Int32

Specifies the length of the user's OTP password.

sharedSecret
Data

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

sshKey
Data

Contains the user's SSH key.

username
String

The registered name (login) of the user.

Constructors

public init()

Creates a new UserAccount object.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8165]