base/guid.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef BASE_GUID_H_
   6 #define BASE_GUID_H_
   7
   8 #include <stdint.h>
   9
  10 #include <string>
  11
  12 #include "base/base_export.h"
  13 #include "base/strings/string_piece.h"
  14 #include "build/build_config.h"
  15
  16 namespace base {
  17
  18 // Generate a 128-bit random GUID in the form of version 4 as described in
  19 // RFC 4122, section 4.4.
  20 // The format of GUID version 4 must be xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx,
  21 // where y is one of [8, 9, A, B].
  22 // The hexadecimal values "a" through "f" are output as lower case characters.
  23 //
  24 // A cryptographically secure random source will be used, but consider using
  25 // UnguessableToken for greater type-safety if GUID format is unnecessary.
  26 BASE_EXPORT std::string GenerateGUID();
  27
  28 // Returns true if the input string conforms to the version 4 GUID format.
  29 // Note that this does NOT check if the hexadecimal values "a" through "f"
  30 // are in lower case characters, as Version 4 RFC says onput they're
  31 // case insensitive. (Use IsValidGUIDOutputString for checking if the
  32 // given string is valid output string)
  33 BASE_EXPORT bool IsValidGUID(base::StringPiece guid);
  34 BASE_EXPORT bool IsValidGUID(base::StringPiece16 guid);
  35
  36 // Returns true if the input string is valid version 4 GUID output string.
  37 // This also checks if the hexadecimal values "a" through "f" are in lower
  38 // case characters.
  39 BASE_EXPORT bool IsValidGUIDOutputString(base::StringPiece guid);
  40
  41 // For unit testing purposes only.  Do not use outside of tests.
  42 BASE_EXPORT std::string RandomDataToGUIDString(const uint64_t bytes[2]);
  43
  44 }  // namespace base
  45
  46 #endif  // BASE_GUID_H_