tsig_250.cc 16.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Copyright (C) 2010  Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#include <string>
#include <sstream>
#include <vector>

#include <boost/lexical_cast.hpp>

21
#include <util/buffer.h>
22
#include <util/strutil.h>
chenzhengzhang's avatar
chenzhengzhang committed
23
#include <util/encode/base64.h>
24

25
#include <dns/messagerenderer.h>
26
#include <dns/name.h>
27
28
#include <dns/rdata.h>
#include <dns/rdataclass.h>
29
#include <dns/tsigerror.h>
30
31
32

using namespace std;
using namespace boost;
33
using namespace isc::util;
chenzhengzhang's avatar
chenzhengzhang committed
34
using namespace isc::util::encode;
35
using namespace isc::util::str;
36
37
38
39

// BEGIN_ISC_NAMESPACE
// BEGIN_RDATA_NAMESPACE

40
/// This is a straightforward representation of TSIG RDATA fields.
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
struct TSIG::TSIGImpl {
    TSIGImpl(const Name& algorithm, uint64_t time_signed, uint16_t fudge,
             vector<uint8_t>& mac, uint16_t original_id, uint16_t error,
             vector<uint8_t>& other_data) :
        algorithm_(algorithm), time_signed_(time_signed), fudge_(fudge),
        mac_(mac), original_id_(original_id), error_(error),
        other_data_(other_data)
    {}
    TSIGImpl(const Name& algorithm, uint64_t time_signed, uint16_t fudge,
             size_t macsize, const void* mac, uint16_t original_id,
             uint16_t error, size_t other_len, const void* other_data) :
        algorithm_(algorithm), time_signed_(time_signed), fudge_(fudge),
        mac_(static_cast<const uint8_t*>(mac),
             static_cast<const uint8_t*>(mac) + macsize),
        original_id_(original_id), error_(error),
        other_data_(static_cast<const uint8_t*>(other_data),
                    static_cast<const uint8_t*>(other_data) + other_len)
    {}
59
60
    template <typename Output>
    void toWireCommon(Output& output) const;
61
62
63
64
65
66
67
68
69
70

    const Name algorithm_;
    const uint64_t time_signed_;
    const uint16_t fudge_;
    const vector<uint8_t> mac_;
    const uint16_t original_id_;
    const uint16_t error_;
    const vector<uint8_t> other_data_;
};

71
72
73
74
75
76
/// \brief Constructor from string.
///
/// \c tsig_str must be formatted as follows:
/// \code <Alg> <Time> <Fudge> <MACsize> [<MAC>] <OrigID> <Error> <OtherLen> [<OtherData>]
/// \endcode
/// where
77
78
/// - &lt;Alg&gt; is a valid textual representation of domain name.
/// - &lt;Time&gt; is an unsigned 48-bit decimal integer.
79
80
/// - &lt;MACSize&gt;, &lt;OrigID&gt;, and &lt;OtherLen&gt; are an unsigned
///   16-bit decimal
81
///   integer.
82
83
/// - &lt;Error&gt; is an unsigned 16-bit decimal integer or a valid mnemonic
///   for the Error field specified in RFC2845.  Currently, "BADSIG", "BADKEY",
84
85
86
///   and "BADTIME" are supported (case sensitive).  In future versions
///   other representations that are compatible with the DNS RCODE will be
///   supported.
87
88
89
90
91
92
93
94
/// - &lt;MAC&gt; and &lt;OtherData&gt; is a BASE-64 encoded string that does
///   not contain space characters.
///   When &lt;MACSize&gt; and &lt;OtherLen&gt; is 0, &lt;MAC&gt; and
///   &lt;OtherData&gt; must not appear in \c tsig_str, respectively.
/// - The decoded data of &lt;MAC&gt; is &lt;MACSize&gt; bytes of binary
///   stream.
/// - The decoded data of &lt;OtherData&gt; is &lt;OtherLen&gt; bytes of
///   binary stream.
95
96
97
///
/// An example of valid string is:
/// \code "hmac-sha256. 853804800 300 3 AAAA 2845 0 0" \endcode
98
/// In this example &lt;OtherData&gt; is missing because &lt;OtherLen&gt; is 0.
99
100
101
102
103
104
105
106
///
/// Note that RFC2845 does not define the standard presentation format
/// of %TSIG RR, so the above syntax is implementation specific.
/// This is, however, compatible with the format acceptable to BIND 9's
/// RDATA parser.
///
/// <b>Exceptions</b>
///
107
/// If &lt;Alg&gt; is not a valid domain name, a corresponding exception from
108
/// the \c Name class will be thrown;
109
110
/// if &lt;MAC&gt; or &lt;OtherData&gt; is not validly encoded in BASE-64, an
/// exception of class \c isc::BadValue will be thrown;
111
112
113
114
/// 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
/// a corresponding standard exception will be thrown.
115
116
117
TSIG::TSIG(const std::string& tsig_str) : impl_(NULL) {
    istringstream iss(tsig_str);

118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
    try {
        const Name algorithm(getToken(iss));
        const int64_t time_signed = tokenToNum<int64_t, 48>(getToken(iss));
        const int32_t fudge = tokenToNum<int32_t, 16>(getToken(iss));
        const int32_t macsize = tokenToNum<int32_t, 16>(getToken(iss));

        const string mac_txt = (macsize > 0) ? getToken(iss) : "";
        vector<uint8_t> mac;
        decodeBase64(mac_txt, mac);
        if (mac.size() != macsize) {
            isc_throw(InvalidRdataText, "TSIG MAC size and data are inconsistent");
        }

        const int32_t orig_id = tokenToNum<int32_t, 16>(getToken(iss));

        const string error_txt = getToken(iss);
        int32_t error = 0;
        // XXX: In the initial implementation we hardcode the mnemonics.
        // We'll soon generalize this.
        if (error_txt == "BADSIG") {
            error = 16;
        } else if (error_txt == "BADKEY") {
            error = 17;
        } else if (error_txt == "BADTIME") {
            error = 18;
        } else {
            error = tokenToNum<int32_t, 16>(error_txt);
        }

        const int32_t otherlen = tokenToNum<int32_t, 16>(getToken(iss));
        const string otherdata_txt = (otherlen > 0) ? getToken(iss) : "";
        vector<uint8_t> other_data;
        decodeBase64(otherdata_txt, other_data);

        if (!iss.eof()) {
            isc_throw(InvalidRdataText, "Unexpected input for TSIG RDATA: " <<
                    tsig_str);
        }

        impl_ = new TSIGImpl(algorithm, time_signed, fudge, mac, orig_id,
                            error, other_data);

160
    } catch (const StringTokenError& ste) {
161
162
        isc_throw(InvalidRdataText, "Invalid TSIG text: " << ste.what() <<
                  ": " << tsig_str);
163
164
165
    }
}

166
/// \brief Constructor from wire-format data.
167
168
169
170
///
/// When a read operation on \c buffer fails (e.g., due to a corrupted
/// message) a corresponding exception from the \c InputBuffer class will
/// be thrown.
171
/// If the wire-format data does not begin with a valid domain name,
172
173
174
175
176
177
178
179
/// a corresponding exception from the \c Name class will be thrown.
/// In addition, this constructor internally involves resource allocation,
/// and if it fails a corresponding standard exception will be thrown.
///
/// According to RFC3597, the Algorithm field must be a non compressed form
/// of domain name.  But this implementation accepts a %TSIG RR even if that
/// field is compressed.
///
180
181
/// \param buffer A buffer storing the wire format data.
/// \param rdata_len The length of the RDATA in bytes, normally expected
182
183
184
185
/// to be the value of the RDLENGTH field of the corresponding RR.
/// But this constructor does not use this parameter; if necessary, the caller
/// must check consistency between the length parameter and the actual
/// RDATA length.
186
TSIG::TSIG(InputBuffer& buffer, size_t) : impl_(NULL) {
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
    Name algorithm(buffer);

    uint8_t time_signed_buf[6];
    buffer.readData(time_signed_buf, sizeof(time_signed_buf));
    const uint64_t time_signed =
        (static_cast<uint64_t>(time_signed_buf[0]) << 40 |
         static_cast<uint64_t>(time_signed_buf[1]) << 32 |
         static_cast<uint64_t>(time_signed_buf[2]) << 24 |
         static_cast<uint64_t>(time_signed_buf[3]) << 16 |
         static_cast<uint64_t>(time_signed_buf[4]) << 8 |
         static_cast<uint64_t>(time_signed_buf[5]));

    const uint16_t fudge = buffer.readUint16();

    const uint16_t mac_size = buffer.readUint16();
    vector<uint8_t> mac(mac_size);
    if (mac_size > 0) {
        buffer.readData(&mac[0], mac_size);
    }

    const uint16_t original_id = buffer.readUint16();
    const uint16_t error = buffer.readUint16();

    const uint16_t other_len = buffer.readUint16();
    vector<uint8_t> other_data(other_len);
    if (other_len > 0) {
        buffer.readData(&other_data[0], other_len);
    }

    impl_ = new TSIGImpl(algorithm, time_signed, fudge, mac, original_id,
                         error, other_data);
}

TSIG::TSIG(const Name& algorithm, uint64_t time_signed, uint16_t fudge,
221
222
           uint16_t mac_size, const void* mac, uint16_t original_id,
           uint16_t error, uint16_t other_len, const void* other_data) :
223
224
    impl_(NULL)
{
225
226
    // Time Signed is a 48-bit value.
    if ((time_signed >> 48) != 0) {
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
        isc_throw(OutOfRange, "TSIG Time Signed is too large: " <<
                  time_signed);
    }
    if ((mac_size == 0 && mac != NULL) || (mac_size > 0 && mac == NULL)) {
        isc_throw(InvalidParameter, "TSIG MAC size and data inconsistent");
    }
    if ((other_len == 0 && other_data != NULL) ||
        (other_len > 0 && other_data == NULL)) {
        isc_throw(InvalidParameter,
                  "TSIG Other data length and data inconsistent");
    }
    impl_ = new TSIGImpl(algorithm, time_signed, fudge, mac_size, mac,
                         original_id, error, other_len, other_data);
}

242
243
244
245
246
/// \brief The copy constructor.
///
/// It internally allocates a resource, and if it fails a corresponding
/// standard exception will be thrown.
/// This constructor never throws an exception otherwise.
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
TSIG::TSIG(const TSIG& source) : Rdata(), impl_(new TSIGImpl(*source.impl_))
{}

TSIG&
TSIG::operator=(const TSIG& source) {
    if (impl_ == source.impl_) {
        return (*this);
    }

    TSIGImpl* newimpl = new TSIGImpl(*source.impl_);
    delete impl_;
    impl_ = newimpl;

    return (*this);
}

TSIG::~TSIG() {
    delete impl_;
}

267
268
/// \brief Convert the \c TSIG to a string.
///
269
/// The output of this method is formatted as described in the "from string"
270
271
272
273
274
275
/// constructor (\c TSIG(const std::string&))).
///
/// If internal resource allocation fails, a corresponding
/// standard exception will be thrown.
///
/// \return A \c string object that represents the \c TSIG object.
276
277
278
279
280
281
282
283
284
285
286
287
std::string
TSIG::toText() const {
    string result;

    result += impl_->algorithm_.toText() + " " +
        lexical_cast<string>(impl_->time_signed_) + " " +
        lexical_cast<string>(impl_->fudge_) + " " +
        lexical_cast<string>(impl_->mac_.size()) + " ";
    if (impl_->mac_.size() > 0) {
        result += encodeBase64(impl_->mac_) + " ";
    }
    result += lexical_cast<string>(impl_->original_id_) + " ";
288
    result += TSIGError(impl_->error_).toText() + " ";
289
290
291
292
293
294
295
296
    result += lexical_cast<string>(impl_->other_data_.size());
    if (impl_->other_data_.size() > 0) {
        result += " " + encodeBase64(impl_->other_data_);
    }

    return (result);
}

297
298
// Common sequence of toWire() operations used for the two versions of
// toWire().
299
300
template <typename Output>
void
301
302
303
304
305
TSIG::TSIGImpl::toWireCommon(Output& output) const {
    output.writeUint16(time_signed_ >> 32);
    output.writeUint32(time_signed_ & 0xffffffff);
    output.writeUint16(fudge_);
    const uint16_t mac_size = mac_.size();
306
307
    output.writeUint16(mac_size);
    if (mac_size > 0) {
308
        output.writeData(&mac_[0], mac_size);
309
    }
310
311
312
    output.writeUint16(original_id_);
    output.writeUint16(error_);
    const uint16_t other_len = other_data_.size();
313
314
    output.writeUint16(other_len);
    if (other_len > 0) {
315
        output.writeData(&other_data_[0], other_len);
316
317
318
    }
}

319
320
321
322
323
324
325
/// \brief Render the \c TSIG in the wire format without name compression.
///
/// If internal resource allocation fails, a corresponding
/// standard exception will be thrown.
/// This method never throws an exception otherwise.
///
/// \param buffer An output buffer to store the wire data.
326
327
328
void
TSIG::toWire(OutputBuffer& buffer) const {
    impl_->algorithm_.toWire(buffer);
329
    impl_->toWireCommon<OutputBuffer>(buffer);
330
331
}

332
333
334
/// \brief Render the \c TSIG in the wire format with taking into account
/// compression.
///
335
/// As specified in RFC3597, the Algorithm field (a domain name) will not
336
337
/// be compressed.  However, the domain name could be a target of compression
/// of other compressible names (though pretty unlikely), the offset
338
/// information of the algorithm name may be recorded in \c renderer.
339
340
341
342
343
344
345
///
/// If internal resource allocation fails, a corresponding
/// standard exception will be thrown.
/// This method never throws an exception otherwise.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer and name compression information.
346
void
347
TSIG::toWire(AbstractMessageRenderer& renderer) const {
348
    renderer.writeName(impl_->algorithm_, false);
349
    impl_->toWireCommon<AbstractMessageRenderer>(renderer);
350
351
}

352
// A helper function commonly used for TSIG::compare().
353
354
355
356
357
358
359
360
361
362
363
364
365
int
vectorComp(const vector<uint8_t>& v1, const vector<uint8_t>& v2) {
    const size_t this_size = v1.size();
    const size_t other_size = v2.size();
    if (this_size != other_size) {
        return (this_size < other_size ? -1 : 1);
    }
    if (this_size > 0) {
        return (memcmp(&v1[0], &v2[0], this_size));
    }
    return (0);
}

366
367
368
/// \brief Compare two instances of \c TSIG RDATA.
///
/// This method compares \c this and the \c other \c TSIG objects
369
/// in terms of the DNSSEC sorting order as defined in RFC4034, and returns
370
371
/// the result as an integer.
///
372
/// This method is expected to be used in a polymorphic way, and the
373
374
375
376
377
378
379
380
381
382
/// parameter to compare against is therefore of the abstract \c Rdata class.
/// However, comparing two \c Rdata objects of different RR types
/// is meaningless, and \c other must point to a \c TSIG object;
/// otherwise, the standard \c bad_cast exception will be thrown.
/// This method never throws an exception otherwise.
///
/// \param other the right-hand operand to compare against.
/// \return < 0 if \c this would be sorted before \c other.
/// \return 0 if \c this is identical to \c other in terms of sorting order.
/// \return > 0 if \c this would be sorted after \c other.
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
int
TSIG::compare(const Rdata& other) const {
    const TSIG& other_tsig = dynamic_cast<const TSIG&>(other);

    const int ncmp = compareNames(impl_->algorithm_,
                                  other_tsig.impl_->algorithm_);
    if (ncmp != 0) {
        return (ncmp);
    }

    if (impl_->time_signed_ != other_tsig.impl_->time_signed_) {
        return (impl_->time_signed_ < other_tsig.impl_->time_signed_ ? -1 : 1);
    }
    if (impl_->fudge_ != other_tsig.impl_->fudge_) {
        return (impl_->fudge_ < other_tsig.impl_->fudge_ ? -1 : 1);
    }
    const int vcmp = vectorComp(impl_->mac_, other_tsig.impl_->mac_);
    if (vcmp != 0) {
        return (vcmp);
    }
    if (impl_->original_id_ != other_tsig.impl_->original_id_) {
        return (impl_->original_id_ < other_tsig.impl_->original_id_ ? -1 : 1);
    }
    if (impl_->error_ != other_tsig.impl_->error_) {
        return (impl_->error_ < other_tsig.impl_->error_ ? -1 : 1);
    }
409
    return (vectorComp(impl_->other_data_, other_tsig.impl_->other_data_));
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
}

const Name&
TSIG::getAlgorithm() const {
    return (impl_->algorithm_);
}

uint64_t
TSIG::getTimeSigned() const {
    return (impl_->time_signed_);
}

uint16_t
TSIG::getFudge() const {
    return (impl_->fudge_);
}

uint16_t
TSIG::getMACSize() const {
    return (impl_->mac_.size());
}

const void*
TSIG::getMAC() const {
    if (impl_->mac_.size() > 0) {
        return (&impl_->mac_[0]);
    } else {
        return (NULL);
    }
}

uint16_t
TSIG::getOriginalID() const {
    return (impl_->original_id_);
}

uint16_t
TSIG::getError() const {
    return (impl_->error_);
}

uint16_t
TSIG::getOtherLen() const {
    return (impl_->other_data_.size());
}

const void*
TSIG::getOtherData() const {
    if (impl_->other_data_.size() > 0) {
        return (&impl_->other_data_[0]);
    } else {
        return (NULL);
    }
}

// END_RDATA_NAMESPACE
// END_ISC_NAMESPACE