Kea 1.5.0
tsig.h
Go to the documentation of this file.
1// Copyright (C) 2011-2015,2017 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7// IMPORTANT: the server side of this code MUST NOT be used until
8// it was fixed, cf draft-dupont-dnsop-rfc2845bis-00.txt
9// Note that Kea uses only the client side.
10
11#ifndef TSIG_H
12#define TSIG_H 1
13
14#include <boost/noncopyable.hpp>
15#include <boost/shared_ptr.hpp>
16
18
19#include <dns/tsigerror.h>
20#include <dns/tsigkey.h>
21#include <dns/tsigrecord.h>
22
23namespace isc {
24namespace dns {
25
33public:
34 TSIGContextError(const char* file, size_t line, const char* what) :
35 isc::Exception(file, line, what) {}
36};
37
172class TSIGContext : boost::noncopyable {
173public:
182 enum State {
188 };
189
192
193
198 explicit TSIGContext(const TSIGKey& key);
199
201 TSIGContext(const Name& key_name, const Name& algorithm_name,
202 const TSIGKeyRing& keyring);
203
205 ~TSIGContext();
207
264 ConstTSIGRecordPtr sign(const uint16_t qid, const void* const data,
265 const size_t data_len);
266
354 TSIGError verify(const TSIGRecord* const record, const void* const data,
355 const size_t data_len);
356
368 bool lastHadSignature() const;
369
389 size_t getTSIGLength() const;
390
398 State getState() const;
399
406 TSIGError getError() const;
407
410
411
415 static const uint16_t DEFAULT_FUDGE = 300;
417
418protected:
429 void update(const void* const data, size_t len);
430
431private:
432 struct TSIGContextImpl;
433 TSIGContextImpl* impl_;
434};
435
436typedef boost::shared_ptr<TSIGContext> TSIGContextPtr;
437typedef boost::shared_ptr<TSIGKey> TSIGKeyPtr;
438
439}
440}
441
442#endif // TSIG_H
443
444// Local Variables:
445// mode: c++
446// End:
This is a base class for exceptions thrown from the DNS library module.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
The Name class encapsulates DNS names.
Definition: name.h:223
An exception that is thrown for logic errors identified in TSIG sign/verify operations.
Definition: tsig.h:32
TSIGContextError(const char *file, size_t line, const char *what)
Definition: tsig.h:34
TSIG session context.
Definition: tsig.h:172
State
Internal state of context.
Definition: tsig.h:182
@ RECEIVED_REQUEST
Server received a signed request.
Definition: tsig.h:185
@ SENT_REQUEST
Client sent a signed request, waiting response.
Definition: tsig.h:184
@ SENT_RESPONSE
Server sent a signed response.
Definition: tsig.h:186
@ VERIFIED_RESPONSE
Client successfully verified a response.
Definition: tsig.h:187
@ INIT
Initial state.
Definition: tsig.h:183
ConstTSIGRecordPtr sign(const uint16_t qid, const void *const data, const size_t data_len)
Sign a DNS message.
Definition: tsig.cc:344
static const uint16_t DEFAULT_FUDGE
The recommended fudge value (in seconds) by RFC2845.
Definition: tsig.h:415
TSIGError getError() const
Return the TSIG error as a result of the latest verification.
Definition: tsig.cc:339
size_t getTSIGLength() const
Return the expected length of TSIG RR after sign()
Definition: tsig.cc:295
~TSIGContext()
The destructor.
Definition: tsig.cc:290
void update(const void *const data, size_t len)
Update internal HMAC state by more data.
Definition: tsig.cc:576
TSIGError verify(const TSIGRecord *const record, const void *const data, const size_t data_len)
Verify a DNS message.
Definition: tsig.cc:428
State getState() const
Return the current state of the context.
Definition: tsig.cc:334
bool lastHadSignature() const
Check whether the last verified message was signed.
Definition: tsig.cc:568
TSIG errors.
Definition: tsigerror.h:22
A simple repository of a set of TSIGKey objects.
Definition: tsigkey.h:245
TSIG key.
Definition: tsigkey.h:56
TSIG resource record.
Definition: tsigrecord.h:54
boost::shared_ptr< TSIGContext > TSIGContextPtr
Definition: tsig.h:436
boost::shared_ptr< const TSIGRecord > ConstTSIGRecordPtr
A pointer-like type pointing to an immutable TSIGRecord object.
Definition: tsigrecord.h:280
boost::shared_ptr< TSIGKey > TSIGKeyPtr
Definition: tsig.h:437
Defines the logger used by the top-level component of kea-dhcp-ddns.