TrueName.hxx

Go to the documentation of this file.

#ifndef COMMON_TRUENAME_HXX
#define COMMON_TRUENAME_HXX

/*
 * Copyright (c) 2004, The EROS Group, LLC and Johns Hopkins
 * University. All rights reserved.
 * 
 * This software was developed to support the EROS secure operating
 * system project (http://www.eros-os.org). The latest version of
 * the OpenCM software can be found at http://www.opencm.org.
 * 
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 * 
 * 3. Neither the name of the The EROS Group, LLC nor the name of
 *    Johns Hopkins University, nor the names of its contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

struct OPENCM_SHA;

/* This structure really ought to be opaque, but the binary
   serialization logic effectively needs to know all of it. */
enum TrueNameKind {
  TNK_NULL = 0,         /* Reserved for serialization! */
  TNK_SHA1 = 1,
  TNK_NID  = 2,
  TNK_CFG  = 3
};

#define SHA1_PREFIX "sha1"
#define NID_PREFIX "nid"

#define TNV_MAXLEN 20
struct TrueName {
public:
  struct BoolConversionSupport {
    int dummy;
  };

  uint8_t kind;
  ByteString value;

  static size_t repLen(uint8_t kind);
  static std::string NewName();

  hash32_t hash();
  std::string asHumanString() const;
  std::string asStringOldFormat() const;

private:
  void set_from_sha(const OpenSHA& sha);

public:
  TrueName()
  {
    kind = TNK_NULL;
  }

  TrueName(TrueNameKind k)
  {
    kind = k;
  }

  TrueName(const TrueName& tn);
  TrueName(const OpenSHA& sha);
  TrueName(uint32_t len, const void *s);

  static TrueName OfString(std::string);

  int cmp(const TrueName& tn);
  bool operator==(const TrueName& tn);
  bool operator!=(const TrueName& tn)
  {
    return !(*this == tn);
  }

  inline operator int BoolConversionSupport::* () const
    {
      return (kind == TNK_NULL) ? 0 : &BoolConversionSupport::dummy;
    }

  // Support for trees and maps:
  bool operator<(const TrueName& other) const
  {
    if (kind < other.kind)
      return true;
    if (kind > other.kind)
      return false;

    return value < other.value;
  }

  bool operator>(const TrueName& other) const
  {
    if (kind > other.kind)
      return true;
    if (kind > other.kind)
      return false;

    return value > other.value;
  }

  static TrueName Null;
  static TrueName CfgDir;
};

// Local Variables:
// mode:c++
// End:

#endif /* COMMON_TRUENAME_HXX */

---