#include <QtCrypto>
Secure array of bytes.
The SecureArray provides an array of memory from a pool that is, at least partly, secure. In this sense, secure means that the contents of the memory should not be made available to other applications. By comparison, a QByteArray or QString may be held in pages that might be swapped to disk or free'd without being cleared first.
Note that this class is implicitly shared (that is, copy on write).
- Examples
- aes-cmac.cpp, ciphertest.cpp, eventhandlerdemo.cpp, hashtest.cpp, keyloader.cpp, mactest.cpp, md5crypt.cpp, publickeyexample.cpp, randomtest.cpp, rsatest.cpp, and saslclient.cpp.
◆ SecureArray() [1/6]
QCA::SecureArray::SecureArray |
( |
| ) |
|
Construct a secure byte array, zero length.
◆ SecureArray() [2/6]
QCA::SecureArray::SecureArray |
( |
int |
size, |
|
|
char |
ch = 0 |
|
) |
| |
|
explicit |
Construct a secure byte array of the specified length.
- Parameters
-
size | the number of bytes in the array |
ch | the value every byte should be set to |
◆ SecureArray() [3/6]
QCA::SecureArray::SecureArray |
( |
const char * |
str | ) |
|
Construct a secure byte array from a string.
Note that this copies, rather than references the source array.
- Parameters
-
str | the source of the data (as a null terminated string). |
◆ SecureArray() [4/6]
QCA::SecureArray::SecureArray |
( |
const QByteArray & |
a | ) |
|
Construct a secure byte array from a QByteArray.
Note that this copies, rather than references the source array.
- Parameters
-
- See also
- operator=()
◆ SecureArray() [5/6]
Construct a secure byte array from a MemoryRegion.
Note that this copies, rather than references the source array
- Parameters
-
- See also
- operator=()
◆ SecureArray() [6/6]
QCA::SecureArray::SecureArray |
( |
const SecureArray & |
from | ) |
|
Construct a (shallow) copy of another secure byte array.
- Parameters
-
from | the source of the data and length. |
◆ operator=() [1/2]
Creates a reference, rather than a deep copy.
- Parameters
-
from | the array to reference |
◆ operator=() [2/2]
SecureArray & QCA::SecureArray::operator= |
( |
const QByteArray & |
a | ) |
|
Creates a copy, rather than references.
- Parameters
-
◆ clear()
void QCA::SecureArray::clear |
( |
| ) |
|
Clears the contents of the array and makes it empty.
- Examples
- md5crypt.cpp.
◆ operator[]() [1/2]
char & QCA::SecureArray::operator[] |
( |
int |
index | ) |
|
Returns a reference to the byte at the index position.
- Parameters
-
index | the zero-based offset to obtain |
◆ operator[]() [2/2]
const char & QCA::SecureArray::operator[] |
( |
int |
index | ) |
const |
Returns a reference to the byte at the index position.
- Parameters
-
index | the zero-based offset to obtain |
◆ data() [1/2]
char * QCA::SecureArray::data |
( |
| ) |
|
◆ data() [2/2]
const char * QCA::SecureArray::data |
( |
| ) |
const |
Pointer to the data in the secure array.
You can use this for memcpy and similar functions. If you are trying to obtain data at a particular offset, you might be better off using at() or operator[]
◆ constData()
const char * QCA::SecureArray::constData |
( |
| ) |
const |
Pointer to the data in the secure array.
You can use this for memcpy and similar functions. If you are trying to obtain data at a particular offset, you might be better off using at() or operator[]
◆ at() [1/2]
char & QCA::SecureArray::at |
( |
int |
index | ) |
|
Returns a reference to the byte at the index position.
- Parameters
-
index | the zero-based offset to obtain |
◆ at() [2/2]
const char & QCA::SecureArray::at |
( |
int |
index | ) |
const |
Returns a reference to the byte at the index position.
- Parameters
-
index | the zero-based offset to obtain |
◆ size()
int QCA::SecureArray::size |
( |
| ) |
const |
◆ isEmpty()
bool QCA::SecureArray::isEmpty |
( |
| ) |
const |
Test if the array contains any bytes.
This is equivalent to testing (size() != 0). Note that if the array is allocated, isEmpty() is false (even if no data has been added)
- Returns
- true if the array has zero length, otherwise false
- Examples
- rsatest.cpp.
◆ resize()
bool QCA::SecureArray::resize |
( |
int |
size | ) |
|
Change the length of this array If the new length is less than the old length, the extra information is (safely) discarded.
If the new length is equal to or greater than the old length, the existing data is copied into the array.
- Parameters
-
◆ fill()
void QCA::SecureArray::fill |
( |
char |
fillChar, |
|
|
int |
fillToPosition = -1 |
|
) |
| |
Fill the data array with a specified character.
- Parameters
-
fillChar | the character to use as the fill |
fillToPosition | the number of characters to fill to. If not specified (or -1), fills array to current length. |
- Note
- This function does not extend the array - if you ask for fill beyond the current length, only the current length will be used.
-
The number of characters is 1 based, so if you ask for fill('x', 10), it will fill from
- Examples
- md5crypt.cpp.
◆ toByteArray()
QByteArray QCA::SecureArray::toByteArray |
( |
| ) |
const |
◆ append()
Append a secure byte array to the end of this array.
- Parameters
-
a | the array to append to this array |
- Examples
- ciphertest.cpp, and md5crypt.cpp.
◆ operator==()
bool QCA::SecureArray::operator== |
( |
const MemoryRegion & |
other | ) |
const |
Equality operator.
Returns true if both arrays have the same data (and the same length, of course).
- Parameters
-
◆ operator!=()
bool QCA::SecureArray::operator!= |
( |
const MemoryRegion & |
other | ) |
const |
|
inline |
Inequality operator.
Returns true if both arrays have different length, or the same length but different data.
- Parameters
-
◆ operator+=()
Append a secure byte array to the end of this array.
- Parameters
-
a | the array to append to this array |
◆ set() [1/2]
Assign the contents of a provided byte array to this object.
- Parameters
-
from | the byte array to copy |
◆ set() [2/2]
void QCA::SecureArray::set |
( |
const QByteArray & |
from | ) |
|
|
protected |
Assign the contents of a provided byte array to this object.
- Parameters
-
from | the byte array to copy |
The documentation for this class was generated from the following file: