|
@@ -76,19 +76,22 @@ struct TSIG::TSIGImpl {
|
|
|
/// where
|
|
|
/// - <Alg> is a valid textual representation of domain name.
|
|
|
/// - <Time> is an unsigned 48-bit decimal integer.
|
|
|
-/// - <MACSize>, <OrigID>, and <OtherLen> are an unsigned 16-bit decimal
|
|
|
+/// - <MACSize>, <OrigID>, and <OtherLen> are an unsigned
|
|
|
+/// 16-bit decimal
|
|
|
/// integer.
|
|
|
-/// - <Error> is an unsigned 16-bit decimal integer or a valid mnemonic for
|
|
|
-/// the Error field specified in RFC2845. Currently, "BADSIG", "BADKEY",
|
|
|
+/// - <Error> is an unsigned 16-bit decimal integer or a valid mnemonic
|
|
|
+/// for the Error field specified in RFC2845. Currently, "BADSIG", "BADKEY",
|
|
|
/// and "BADTIME" are supported (case sensitive). In future versions
|
|
|
/// other representations that are compatible with the DNS RCODE will be
|
|
|
/// supported.
|
|
|
-/// - <MAC> and <OtherData> is a BASE-64 encoded string that does not contain
|
|
|
-/// space characters.
|
|
|
-/// When <MACSize> and <OtherLen> is 0, <MAC> and <OtherData> must not
|
|
|
-/// appear in \c tsgi_str, respectively.
|
|
|
-/// - The decoded data of <MAC> is <MACSize> bytes of binary stream.
|
|
|
-/// - The decoded data of <OtherData> is <OtherLen> bytes of binary stream.
|
|
|
+/// - <MAC> and <OtherData> is a BASE-64 encoded string that does
|
|
|
+/// not contain space characters.
|
|
|
+/// When <MACSize> and <OtherLen> is 0, <MAC> and
|
|
|
+/// <OtherData> must not appear in \c tsig_str, respectively.
|
|
|
+/// - The decoded data of <MAC> is <MACSize> bytes of binary
|
|
|
+/// stream.
|
|
|
+/// - The decoded data of <OtherData> is <OtherLen> bytes of
|
|
|
+/// binary stream.
|
|
|
///
|
|
|
/// An example of valid string is:
|
|
|
/// \code "hmac-sha256. 853804800 300 3 AAAA 2845 0 0" \endcode
|
|
@@ -103,8 +106,8 @@ struct TSIG::TSIGImpl {
|
|
|
///
|
|
|
/// If <Alg> is not a valid domain name, a corresponding exception from
|
|
|
/// the \c Name class will be thrown;
|
|
|
-/// if <MAC> or <OtherData> is not validly encoded in BASE-64, an exception
|
|
|
-/// of class \c isc::BadValue will be thrown;
|
|
|
+/// if <MAC> or <OtherData> is not validly encoded in BASE-64, an
|
|
|
+/// exception of class \c isc::BadValue will be thrown;
|
|
|
/// if %any of the other bullet points above is not met, an exception of
|
|
|
/// class \c InvalidRdataText will be thrown.
|
|
|
/// This constructor internally involves resource allocation, and if it fails
|