Botan 3.4.0
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::UUID Class Referencefinal

#include <uuid.h>

Public Member Functions

const std::vector< uint8_t > & binary_value () const
 
bool is_valid () const
 
bool operator!= (const UUID &other) const
 
UUIDoperator= (const UUID &other)=default
 
bool operator== (const UUID &other) const
 
std::string to_string () const
 
 UUID ()
 
 UUID (const std::vector< uint8_t > &blob)
 
 UUID (const UUID &other)=default
 
 UUID (RandomNumberGenerator &rng)
 
 UUID (std::string_view uuid_str)
 

Detailed Description

Definition at line 21 of file uuid.h.

Constructor & Destructor Documentation

◆ UUID() [1/5]

Botan::UUID::UUID ( )
inline

Create an uninitialized UUID object

Definition at line 26 of file uuid.h.

26: m_uuid() {}

◆ UUID() [2/5]

Botan::UUID::UUID ( RandomNumberGenerator & rng)

Create a random UUID

Definition at line 17 of file uuid.cpp.

17 {
18 m_uuid.resize(16);
19 rng.randomize(m_uuid.data(), m_uuid.size());
20
21 // Mark as a random v4 UUID (RFC 4122 sec 4.4)
22 m_uuid[6] = 0x40 | (m_uuid[6] & 0x0F);
23
24 // Set reserved bits
25 m_uuid[8] = 0x80 | (m_uuid[8] & 0x3F);
26}

References Botan::RandomNumberGenerator::randomize().

◆ UUID() [3/5]

Botan::UUID::UUID ( const std::vector< uint8_t > & blob)

Load a UUID from a 16 byte vector

Definition at line 28 of file uuid.cpp.

28 {
29 if(blob.size() != 16) {
30 throw Invalid_Argument("Bad UUID blob " + hex_encode(blob));
31 }
32
33 m_uuid = blob;
34}
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition hex.cpp:33

References Botan::hex_encode().

◆ UUID() [4/5]

Botan::UUID::UUID ( const UUID & other)
default

◆ UUID() [5/5]

Botan::UUID::UUID ( std::string_view uuid_str)

Decode a UUID string

Definition at line 36 of file uuid.cpp.

36 {
37 if(uuid_str.size() != 36 || uuid_str[8] != '-' || uuid_str[13] != '-' || uuid_str[18] != '-' ||
38 uuid_str[23] != '-') {
39 throw Invalid_Argument(fmt("Bad UUID '{}'", uuid_str));
40 }
41
42 std::string just_hex;
43 for(char c : uuid_str) {
44 if(c == '-') {
45 continue;
46 }
47
48 just_hex += c;
49 }
50
51 m_uuid = hex_decode(just_hex);
52
53 if(m_uuid.size() != 16) {
54 throw Invalid_Argument(fmt("Bad UUID '{}'", uuid_str));
55 }
56}
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53
size_t hex_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition hex.cpp:81

References Botan::fmt(), and Botan::hex_decode().

Member Function Documentation

◆ binary_value()

const std::vector< uint8_t > & Botan::UUID::binary_value ( ) const
inline

Definition at line 51 of file uuid.h.

51{ return m_uuid; }

◆ is_valid()

bool Botan::UUID::is_valid ( ) const
inline

Definition at line 57 of file uuid.h.

57{ return m_uuid.size() == 16; }

Referenced by Botan::TPM_PrivateKey::register_key(), and to_string().

◆ operator!=()

bool Botan::UUID::operator!= ( const UUID & other) const
inline

Definition at line 55 of file uuid.h.

55{ return !(*this == other); }

◆ operator=()

UUID & Botan::UUID::operator= ( const UUID & other)
default

◆ operator==()

bool Botan::UUID::operator== ( const UUID & other) const
inline

Definition at line 53 of file uuid.h.

53{ return m_uuid == other.m_uuid; }

◆ to_string()

std::string Botan::UUID::to_string ( ) const

Convert the UUID to a string

Definition at line 58 of file uuid.cpp.

58 {
59 if(is_valid() == false) {
60 throw Invalid_State("UUID object is empty cannot convert to string");
61 }
62
63 const std::string raw = hex_encode(m_uuid);
64
65 std::ostringstream formatted;
66
67 for(size_t i = 0; i != raw.size(); ++i) {
68 if(i == 8 || i == 12 || i == 16 || i == 20) {
69 formatted << "-";
70 }
71 formatted << raw[i];
72 }
73
74 return formatted.str();
75}
bool is_valid() const
Definition uuid.h:57

References Botan::hex_encode(), and is_valid().

Referenced by Botan::TPM_PrivateKey::register_key().


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