nsec3hash_python_inc.cc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. namespace {
  2. // Modifications
  3. // - removed intermediate details note, mainly for brevity
  4. // - removed std::bad_alloc
  5. const char* const NSEC3Hash_doc = "\
  6. A calculator of NSEC3 hashes.\n\
  7. \n\
  8. This is a simple class that encapsulates the algorithm of calculating\n\
  9. NSEC3 hash values as defined in RFC5155.\n\
  10. \n\
  11. NSEC3Hash(param)\n\
  12. \n\
  13. Constructor from NSEC3PARAM RDATA.\n\
  14. \n\
  15. The hash algorithm given via param must be known to the\n\
  16. implementation. Otherwise UnknownNSEC3HashAlgorithm exception will\n\
  17. be thrown.\n\
  18. \n\
  19. Exceptions:\n\
  20. UnknownNSEC3HashAlgorithm The specified algorithm in param is\n\
  21. unknown.\n\
  22. \n\
  23. Parameters:\n\
  24. param NSEC3 parameters used for subsequent calculation.\n\
  25. \n\
  26. ";
  27. const char* const NSEC3Hash_calculate_doc = "\
  28. calculate(Name) -> string\n\
  29. \n\
  30. Calculate the NSEC3 hash.\n\
  31. \n\
  32. This method calculates the NSEC3 hash value for the given name with\n\
  33. the hash parameters (algorithm, iterations and salt) given at\n\
  34. construction, and returns the value in a base32hex-encoded string\n\
  35. (without containing any white spaces). All US-ASCII letters in the\n\
  36. string will be upper cased.\n\
  37. \n\
  38. Parameters:\n\
  39. name The domain name for which the hash value is to be\n\
  40. calculated.\n\
  41. \n\
  42. Return Value(s): Base32hex-encoded string of the hash value.\n\
  43. ";
  44. } // unnamed namespace