Dsa Ruby Reference Documentation

CkDsa

Current Version: 11.5.0
Requires Chilkat Bundle License

Chilkat.Dsa

Generate, import, export, sign, and verify DSA keys and signatures.

Chilkat.Dsa is the Chilkat class for DSA key generation, DSA key import/export, DSA hash signing, and DSA signature verification. It supports private and public keys in DER, PEM, encrypted PEM, XML, explicit component, and OpenSSL parameter workflows. It also exposes DSA key components as hex-encoded SSH1-format bignums and provides helpers for working with encoded hashes and signatures.

Generate DSA keys

Create DSA key pairs and parameters for workflows that still require DSA-based signing or verification.

Import and export keys

Load and save private or public DSA keys in DER, PEM, encrypted PEM, XML, component-based, and OpenSSL-compatible formats.

Sign hashes

Create DSA signatures over message digests using a loaded private key and the appropriate encoded hash input.

Verify signatures

Verify DSA signatures using a public key, encoded hash, and signature data.

Key components

Access DSA parameters and key components as hex-encoded SSH1-format bignums for low-level interoperability scenarios.

Encoded data helpers

Work with encoded hashes and signatures when applications need hex, Base64, or other textual representations of binary values.

Common pattern: Load or generate a DSA key, compute the message hash with the desired hash algorithm, then use Dsa to sign the hash with the private key or verify the signature with the public key. For new protocol designs, consider whether a more modern signature algorithm is preferred; use this class when DSA is required for compatibility.

For an extended overview, see Dsa Class Overview.

Object Creation

obj = Chilkat::CkDsa.new()

Properties

DebugLogFilePath
# strVal is a string
# ckStr is a CkString
dsa.get_DebugLogFilePath(ckStr);
strVal = dsa.debugLogFilePath();
dsa.put_DebugLogFilePath(strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
GroupSize
# intVal is an integer
intVal = dsa.get_GroupSize();
dsa.put_GroupSize(intVal);

Specifies the size, in bits, of the DSA subgroup parameter Q used by the legacy GenKey method. The default is 160. This also determines the natural size of the DSA signature components r and s.

Applications should normally leave this property at its default. When an explicit standards-era (L, N) parameter pair is required, use GenKey2, where L is the bit length of P and N is the bit length of Q.

Legacy algorithm: NIST FIPS 186-5 no longer approves DSA for generating new digital signatures. Retain DSA generation and signing only for interoperability with systems or data formats that specifically require it; DSA verification remains useful for legacy signatures.

top
HexG
# strVal is a string
# ckStr is a CkString
dsa.get_HexG(ckStr);
strVal = dsa.hexG();

Returns the DSA domain parameter G, the generator of the subgroup of order Q modulo P.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

top
HexP
# strVal is a string
# ckStr is a CkString
dsa.get_HexP(ckStr);
strVal = dsa.hexP();

Returns the DSA domain parameter P, the large prime modulus.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

top
HexQ
# strVal is a string
# ckStr is a CkString
dsa.get_HexQ(ckStr);
strVal = dsa.hexQ();

Returns the DSA domain parameter Q, a prime divisor of P - 1. The bit length of Q is commonly written as N and determines the range of the private value X and signature components r and s.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

top
HexX
# strVal is a string
# ckStr is a CkString
dsa.get_HexX(ckStr);
strVal = dsa.hexX();

Returns the DSA private value X. It is present only when the object contains a private key and satisfies 0 < X < Q.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

Sensitive value: Anyone who obtains X can create signatures as the key owner. Do not log, transmit, or persist this value unless it is protected as private-key material.

top
HexY
# strVal is a string
# ckStr is a CkString
dsa.get_HexY(ckStr);
strVal = dsa.hexY();

Returns the DSA public value Y, where Y = GX mod P. It is available when either a public or private DSA key is loaded.

The returned text is a hexadecimal encoding of Chilkat's SSH1-format bignum representation, which includes a two-byte bit-length prefix followed by the unsigned integer bytes.

top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
dsa.get_LastErrorHtml(ckStr);
strVal = dsa.lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
# strVal is a string
# ckStr is a CkString
dsa.get_LastErrorText(ckStr);
strVal = dsa.lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
# strVal is a string
# ckStr is a CkString
dsa.get_LastErrorXml(ckStr);
strVal = dsa.lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
# boolVal is a boolean
boolVal = dsa.get_LastMethodSuccess();
dsa.put_LastMethodSuccess(boolVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
UncommonOptions
# strVal is a string
# ckStr is a CkString
dsa.get_UncommonOptions(ckStr);
strVal = dsa.uncommonOptions();
dsa.put_UncommonOptions(strVal);
Introduced in version 9.5.0.90

Reserved for uncommon or compatibility-specific options. The default is the empty string, and applications should normally leave this property unchanged unless Chilkat documentation or support identifies a specific keyword required for the target system.

top
Utf8
# boolVal is a boolean
boolVal = dsa.get_Utf8();
dsa.put_Utf8(boolVal);

When set to true, all string arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.

More Information and Examples
Strings in Ruby: Encoding, UTF-8, and Source File Format Considerations
top
VerboseLogging
# boolVal is a boolean
boolVal = dsa.get_VerboseLogging();
dsa.put_VerboseLogging(boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# strVal is a string
# ckStr is a CkString
dsa.get_Version(ckStr);
strVal = dsa.version();

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

FromDerBd
# bd is a CkBinData
status = dsa.FromDerBd(bd);
Introduced in version 11.0.0

Loads a DSA private key from the DER bytes contained in the BinData object passed in bd. Returns true on successful decoding.

Private-key handling: The BinData content contains secret key material and should be cleared or released when no longer needed.

Returns true for success, false for failure.

top
FromDerFile
# path is a string
status = dsa.FromDerFile(path);

Loads a DSA private key from the DER-encoded file specified by path. Returns true when the file is read and decoded successfully; otherwise returns false.

Private-key handling: Restrict access to the file because it contains secret key material. Check LastErrorText when loading fails.

Returns true for success, false for failure.

More Information and Examples
Convert DSA DER Private Key to PEM
top
FromEncryptedPem
# password is a string
# pemData is a string
status = dsa.FromEncryptedPem(password, pemData);

Loads a DSA private key from the PEM text in pemData. password supplies the password when the PEM is encrypted. If the PEM is unencrypted, the password is ignored and the key is loaded normally.

Returns true on success and false if the PEM cannot be decoded, the password is incorrect, or the contained key is not a supported DSA private key.

Security: Do not embed production passwords in source code or log the PEM text. Prefer protected secret storage and encrypted private-key files where practical.

Returns true for success, false for failure.

top
FromPem
# pemData is a string
status = dsa.FromPem(pemData);

Loads an unencrypted DSA private key from the PEM text in pemData. On success, the object contains the private key and its corresponding public components.

Unencrypted private key: PEM armor is only a text encoding; it does not protect the private key. Treat the string as highly sensitive and use FromEncryptedPem when password-protected PEM is available.

Returns true for success, false for failure.

More Information and Examples
DSA Signature Create and Verify
top
FromPublicDerBd
# bd is a CkBinData
status = dsa.FromPublicDerBd(bd);
Introduced in version 11.0.0

Loads a DSA public key from the DER bytes contained in the BinData object passed in bd. The resulting key can verify signatures but cannot sign.

Returns true for success, false for failure.

top
FromPublicDerFile
# path is a string
status = dsa.FromPublicDerFile(path);

Loads a DSA public key from the DER-encoded file specified by path. Returns true when the file is read and decoded successfully; otherwise returns false.

Returns true for success, false for failure.

top
FromPublicPem
# pemData is a string
status = dsa.FromPublicPem(pemData);

Loads a DSA public key from the PEM text in pemData. Returns true when the PEM contains a supported DSA public key and is decoded successfully.

Returns true for success, false for failure.

top
FromXml
# xmlKey is a string
status = dsa.FromXml(xmlKey);

Loads a DSA public or private key from the XML text in xmlKey. The XML content determines whether the resulting object contains public components only or also includes the private value X.

Security: XML is only a representation format. If the XML contains X, it contains the complete private key and must be protected accordingly.

Returns true for success, false for failure.

top
GenKey
# numBits is an integer
status = dsa.GenKey(numBits);

Generates a new DSA key pair with a P size of numBits bits. numBits must be at least 1024 and a multiple of 64. This legacy method uses the subgroup size selected by GroupSize, whose default is 160 bits.

For explicit standard parameter pairs such as (2048, 224) or (3072, 256), use GenKey2.

Legacy algorithm: DSA signature generation is no longer approved by FIPS 186-5. Generate new DSA keys only when required for compatibility with an existing protocol, key store, or signature format.

Returns true for success, false for failure.

More Information and Examples
DSA Generate Key
top
GenKey2
# keyLenBits is an integer
# modLenBits is an integer
status = dsa.GenKey2(keyLenBits, modLenBits);
Introduced in version 9.5.0.90

Generates a new DSA key pair using an explicit (L, N) parameter-size combination. keyLenBits is L, the bit length of the prime modulus P. modLenBits is N, the bit length of the subgroup prime Q.

LNHistorical FIPS 186-4 combination
1024160Legacy
2048224 or 256Supported parameter pairs
3072256Largest listed pair
Current standards status: These combinations come from the superseded FIPS 186-4 DSA specification. FIPS 186-5 no longer approves DSA signature generation; use this method only for compatibility.

Returns true for success, false for failure.

top
GenKeyFromParamsDerBd
# bd is a CkBinData
status = dsa.GenKeyFromParamsDerBd(bd);
Introduced in version 11.0.0

Generates a new DSA key pair from OpenSSL-style DSA parameters stored as DER bytes in the BinData object passed in bd.

The supplied data contains DSA domain parameters P, Q, and G, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value X and corresponding public value Y.

Returns true for success, false for failure.

top
GenKeyFromParamsDerFile
# path is a string
status = dsa.GenKeyFromParamsDerFile(path);

Generates a new DSA key pair from the OpenSSL-style DER DSA-parameters file specified by path.

The supplied data contains DSA domain parameters P, Q, and G, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value X and corresponding public value Y.

Returns true when the parameters are loaded and a key pair is generated successfully.

Returns true for success, false for failure.

More Information and Examples
Generate new DSA Key from OpenSSL Parameters File
top
GenKeyFromParamsPem
# pem is a string
status = dsa.GenKeyFromParamsPem(pem);

Generates a new DSA key pair from OpenSSL-style DSA parameters supplied as PEM text in pem.

The supplied data contains DSA domain parameters P, Q, and G, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value X and corresponding public value Y.

Returns true for success, false for failure.

top
GenKeyFromParamsPemFile
# path is a string
status = dsa.GenKeyFromParamsPemFile(path);

Generates a new DSA key pair from the OpenSSL-style PEM DSA-parameters file specified by path.

The supplied data contains DSA domain parameters P, Q, and G, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value X and corresponding public value Y.

A typical parameter file is PEM-armored with a BEGIN DSA PARAMETERS header. The newly generated private key can be exported with the applicable To* methods.

Returns true for success, false for failure.

top
GenKeyFromPQG
# pHex is a string
# qHex is a string
# gHex is a string
status = dsa.GenKeyFromPQG(pHex, qHex, gHex);
Introduced in version 9.5.0.90

Generates a new DSA private/public key pair using the preselected domain parameters P, Q, and G supplied in pHex, qHex, and gHex.

Each argument is hexadecimal text in Chilkat's SSH1-format bignum representation. Chilkat generates a fresh private value X and derives Y; the supplied values are domain parameters, not an existing key pair.

Parameter provenance: Only use DSA parameters obtained from a trusted, validated source. Malformed or maliciously chosen domain parameters can undermine signature security.

Returns true for success, false for failure.

top
GetEncodedHash
# encoding is a string
# outStr is a CkString (output)
status = dsa.GetEncodedHash(encoding, outStr);
retStr = dsa.getEncodedHash(encoding);

Returns the current Hash bytes encoded according to encoding. Use hex or base64.

This method does not compute a hash; it only converts the bytes already stored in the Hash property to text.

Returns true for success, false for failure.

top
GetEncodedSignature
# encoding is a string
# outStr is a CkString (output)
status = dsa.GetEncodedSignature(encoding, outStr);
retStr = dsa.getEncodedSignature(encoding);

Returns the current Signature bytes encoded according to encoding. Use hex or base64.

After a successful SignHash call, the returned bytes are the ASN.1 DER-encoded DSA signature containing the integers r and s.

Returns true for success, false for failure.

top
LoadText
# path is a string
# outStr is a CkString (output)
status = dsa.LoadText(path, outStr);
retStr = dsa.loadText(path);

Loads the entire file specified by path and returns its contents as text using the legacy ANSI character encoding.

Encoding note: This convenience method is suitable for ASCII-compatible PEM and similar legacy text. It is not a general Unicode file reader; use an API with an explicit character encoding when UTF-8 or other Unicode text must be preserved.

Returns true for success, false for failure.

top
SaveText
# strToSave is a string
# path is a string
status = dsa.SaveText(strToSave, path);

Writes strToSave to the file specified by path using the legacy ANSI character encoding. Returns true on success.

Encoding note: This convenience method is appropriate for ASCII-compatible PEM text. It can lose characters that are not representable in the active ANSI encoding, so use an explicitly encoded text-writing API for general Unicode content.

Returns true for success, false for failure.

top
SetEncodedHash
# encoding is a string
# encodedHash is a string
status = dsa.SetEncodedHash(encoding, encodedHash);

Decodes encodedHash using the encoding named by encoding and stores the resulting bytes in the Hash property. Use hex or base64.

The decoded value must be the already-computed message digest that will be signed by SignHash or checked by Verify.

Returns true for success, false for failure.

top
SetEncodedSignature
# encoding is a string
# encodedSig is a string
status = dsa.SetEncodedSignature(encoding, encodedSig);

Decodes the signature text in encodedSig using the encoding named by encoding and stores the resulting bytes in the Signature property. Use hex or base64.

The decoded bytes are expected to contain the ASN.1 DER-encoded DSA signature. Set the corresponding Hash and public key before calling Verify.

Returns true for success, false for failure.

top
SetEncodedSignatureRS
# encoding is a string
# encodedR is a string
# encodedS is a string
status = dsa.SetEncodedSignatureRS(encoding, encodedR, encodedS);

Builds the DSA signature from separately encoded r and s integer values. encoding identifies the encoding used by both encodedR and encodedS; use hex or base64.

On success, Signature contains the ASN.1 DER SEQUENCE of the two integers and is ready for use with Verify.

Returns true for success, false for failure.

top
SetKeyExplicit
# groupSizeInBytes is an integer
# pHex is a string
# qHex is a string
# gHex is a string
# xHex is a string
status = dsa.SetKeyExplicit(groupSizeInBytes, pHex, qHex, gHex, xHex);

Loads a DSA private key from explicitly supplied components. groupSizeInBytes is the size of Q in bytes. pHex, qHex, gHex, and xHex provide P, Q, G, and the private value X, respectively.

The corresponding public value Y = GX mod P is derived from the private key.

SSH1 bignums: Each component string is hexadecimal text representing an SSH1-format bignum: a two-byte bit-length prefix followed by the unsigned integer bytes.
Sensitive value: xHex contains the private key. Do not expose it in logs or transmit it over an unprotected channel.

Returns true for success, false for failure.

top
SetPubKeyExplicit
# groupSizeInBytes is an integer
# pHex is a string
# qHex is a string
# gHex is a string
# yHex is a string
status = dsa.SetPubKeyExplicit(groupSizeInBytes, pHex, qHex, gHex, yHex);

Loads a DSA public key from explicitly supplied components. groupSizeInBytes is the size of Q in bytes. pHex, qHex, gHex, and yHex provide P, Q, G, and the public value Y, respectively.

The resulting object can verify DSA signatures but cannot create them.

SSH1 bignums: Each component string is hexadecimal text representing an SSH1-format bignum: a two-byte bit-length prefix followed by the unsigned integer bytes.

Returns true for success, false for failure.

top
SignHash
status = dsa.SignHash();

Creates a DSA signature over the digest currently stored in Hash. A DSA private key must be loaded, and the digest must be set directly or with SetEncodedHash before this method is called.

On success, Signature contains an ASN.1 DER-encoded sequence of the DSA values r and s. Retrieve it with GetEncodedSignature or read the Signature property.

Security-critical nonce: Each DSA signature requires a secret per-signature value. Reuse or poor generation of that value can reveal the private key. Chilkat performs this generation internally; applications should not attempt to reuse signature state.
Standards status: FIPS 186-5 no longer approves DSA for generating new signatures. Use this method only for required legacy interoperability.

Returns true for success, false for failure.

More Information and Examples
DSA Signature Create and Verify
top
ToDerBd
# bd is a CkBinData
status = dsa.ToDerBd(bd);
Introduced in version 11.0.0

Writes the DER-encoded DSA private key to the BinData object passed in bd. Returns true on success.

Sensitive output: The destination contains unencrypted private-key bytes after a successful call. Protect and clear it appropriately.

Returns true for success, false for failure.

top
ToDerFile
# path is a string
status = dsa.ToDerFile(path);

Writes the loaded DSA private key to the DER file specified by path. Returns true on success.

Sensitive output: The file contains unencrypted private-key material. Apply restrictive filesystem permissions and avoid writing it to shared or temporary locations.

Returns true for success, false for failure.

More Information and Examples
DSA Generate Key
top
ToEncryptedPem
# password is a string
# outStr is a CkString (output)
status = dsa.ToEncryptedPem(password, outStr);
retStr = dsa.toEncryptedPem(password);

Returns the loaded DSA private key as password-encrypted PEM text using password as the password.

Password protection: Use a strong password and protect it separately from the PEM. Encrypted PEM reduces exposure at rest but does not make it safe to log or transmit indiscriminately.

Returns true for success, false for failure.

More Information and Examples
DSA Generate KeyConvert DSA DER Private Key to PEM
top
ToPem
# outStr is a CkString (output)
status = dsa.ToPem(outStr);
retStr = dsa.toPem();

Returns the loaded DSA private key as unencrypted PEM text.

Unencrypted private key: PEM armor is not encryption. Anyone who obtains this text can use the private key, so prefer ToEncryptedPem when password protection is required.

Returns true for success, false for failure.

More Information and Examples
Convert DSA DER Private Key to PEM
top
ToPublicDerFile
# path is a string
status = dsa.ToPublicDerFile(path);

Writes the public portion of the loaded DSA key to the DER file specified by path. Returns true on success.

Returns true for success, false for failure.

More Information and Examples
DSA Generate Key
top
ToPublicPem
# outStr is a CkString (output)
status = dsa.ToPublicPem(outStr);
retStr = dsa.toPublicPem();

Returns the public portion of the loaded DSA key as PEM text. Public-key PEM may be distributed to parties that need to verify signatures; it does not contain the private value X.

Returns true for success, false for failure.

More Information and Examples
DSA Generate Key
top
ToXml
# bPublicOnly is a boolean
# outStr is a CkString (output)
status = dsa.ToXml(bPublicOnly, outStr);
retStr = dsa.toXml(bPublicOnly);

Returns the loaded DSA key as XML. Set bPublicOnly to true to export public components only. Set it to false to include the private component when a private key is loaded.

Security: When bPublicOnly is false, the XML can contain the private value X. Protect it as private-key material.

Returns true for success, false for failure.

More Information and Examples
DSA Get Key as XML
top
Verify
status = dsa.Verify();

Verifies the DSA signature currently stored in Signature against the digest stored in Hash, using the loaded public key. Both values must be set before calling this method.

Returns true only when the signature is valid. A false result can indicate an invalid signature, malformed input, an incompatible key, or another operational error; inspect LastErrorText when the reason matters.

Returns true for success, false for failure.

More Information and Examples
DSA Signature Create and VerifyDSA R,S Signature Values
top
VerifyKey
retBool = dsa.VerifyKey();

Checks the mathematical validity and internal consistency of the DSA public or private key currently loaded in the object. Returns true when the key parameters and available key components pass validation.

This does not establish who owns the key, whether the key came from a trusted source, or whether it is suitable for a particular protocol.

More Information and Examples
DSA Signature Create and Verify
top

Deprecated

FromDer Deprecated
# derData is a CkByteData
status = dsa.FromDer(derData);

Loads a DSA private key from the DER-encoded bytes in derData. On success, the object contains both the private and public key components and can sign or verify digests.

Private-key handling: The input contains secret key material. Keep it out of logs and protect any storage or transport that carries these bytes.

Returns true for success, false for failure.

top
FromPublicDer Deprecated
# derData is a CkByteData
status = dsa.FromPublicDer(derData);

Loads a DSA public key from the DER-encoded bytes in derData. A public key can be used with Verify and can be exported, but it cannot be used by SignHash.

Returns true for success, false for failure.

top
GenKeyFromParamsDer Deprecated
# derBytes is a CkByteData
status = dsa.GenKeyFromParamsDer(derBytes);

Generates a new DSA key pair from OpenSSL-style DSA parameters supplied as DER-encoded bytes in derBytes.

The supplied data contains DSA domain parameters P, Q, and G, not an existing private key. Chilkat validates or imports those parameters and generates a fresh private value X and corresponding public value Y.

Returns true for success, false for failure.

top
ToDer Deprecated
# outBytes is a CkByteData (output)
status = dsa.ToDer(outData);

Returns the loaded DSA private key as DER-encoded bytes. A private key must be present; a public-only key cannot be exported by this method.

Sensitive output: The returned bytes contain the private key and must be protected in memory, storage, and transit.

Returns true for success, false for failure.

top
ToPublicDer Deprecated
# outBytes is a CkByteData (output)
status = dsa.ToPublicDer(outData);

Returns the public portion of the loaded DSA key as DER-encoded bytes. This works whether the object contains a public key or a private key with a corresponding public value.

Returns true for success, false for failure.

top
ToPublicDerBd Deprecated
# bd is a CkBinData
status = dsa.ToPublicDerBd(bd);
Introduced in version 11.0.0

Writes the DER-encoded public portion of the loaded DSA key to the BinData object passed in bd. Returns true on success.

Returns true for success, false for failure.

top