module ietf-dots-signal-channel {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-dots-signal-channel";
prefix signal;
import ietf-inet-types {
prefix inet;
}
import ietf-yang-types {
prefix yang;
}
import ietf-access-control-list {
prefix ietf-acl;
}
organization
"IETF DDoS Open Threat Signaling (DOTS) Working Group";
contact
"WG Web:
WG List:
Editor: Konda, Tirumaleswar Reddy
Editor: Mohamed Boucadair
Author: Prashanth Patil
Author: Andrew Mortensen
Author: Nik Teague
";
description
"This module contains YANG definition for the signaling
messages exchanged between a DOTS client and a DOTS server.
Copyright (c) 2018 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2018-01-23 {
description
"Initial revision.";
reference
"RFC XXXX: Distributed Denial-of-Service Open Threat
Signaling (DOTS) Signal Channel";
}
/*
* Groupings
*/
grouping target {
description
"Specifies the targets of the mitigation request.";
leaf-list target-prefix {
type inet:ip-prefix;
description
"IPv4 or IPv6 prefix identifying the target.";
}
list target-port-range {
key "lower-port upper-port";
description
"Port range. When only lower-port is
present, it represents a single port number.";
leaf lower-port {
type inet:port-number;
mandatory true;
description
"Lower port number of the port range.";
}
leaf upper-port {
type inet:port-number;
must ". >= ../lower-port" {
error-message
"The upper port number must be greater than
or equal to lower port number.";
}
description
"Upper port number of the port range.";
}
}
leaf-list target-protocol {
type uint8;
description
"Identifies the target protocol number.
The value '0' means 'all protocols'.
Values are taken from the IANA protocol registry:
https://www.iana.org/assignments/protocol-numbers/
protocol-numbers.xhtml
For example, 6 for TCP or 17 for UDP.";
}
leaf-list target-fqdn {
type inet:domain-name;
description
"FQDN identifying the target.";
}
leaf-list target-uri {
type inet:uri;
description
"URI identifying the target.";
}
}
grouping mitigation-scope {
description
"Specifies the scope of the mitigation request.";
leaf cdid {
type string;
description
"The cdid should be included by a server-domain
DOTS gateway to propagate the client domain
identification information from the
gateway's client-facing-side to the gateway's
server-facing-side, and from the gateway's
server-facing-side to the DOTS server.
It may be used by the final DOTS server
for policy enforcement purposes.";
}
list scope {
key "cuid mid";
description
"The scope of the request.";
leaf cuid {
type string;
description
"A unique identifier that is randomly
generated by a DOTS client to prevent
request collisions. It is expected that the
cuid will remain consistent throughout the
lifetime of the DOTS client.";
}
leaf mid {
type uint32;
description
"Mitigation request identifier.
This identifier must be unique for each mitigation
request bound to the DOTS client.";
}
uses target;
leaf-list alias-name {
type string;
description
"An alias name that points to a resource.";
}
leaf lifetime {
type int32;
units "seconds";
default "3600";
description
"Indicates the lifetime of the mitigation request.
A lifetime of '0' in a mitigation request is an
invalid value.
A lifetime of negative one (-1) indicates indefinite
lifetime for the mitigation request.";
}
leaf mitigation-start {
type uint64;
config false;
description
"Mitigation start time is represented in seconds
relative to 1970-01-01T00:00:00Z in UTC time.";
}
leaf status {
type enumeration {
enum "attack-mitigation-in-progress" {
value 1;
description
"Attack mitigation is in progress (e.g., changing
the network path to re-route the inbound traffic
to DOTS mitigator).";
}
enum "attack-successfully-mitigated" {
value 2;
description
"Attack is successfully mitigated (e.g., traffic
is redirected to a DDoS mitigator and attack
traffic is dropped or blackholed).";
}
enum "attack-stopped" {
value 3;
description
"Attack has stopped and the DOTS client can
withdraw the mitigation request.";
}
enum "attack-exceeded-capability" {
value 4;
description
"Attack has exceeded the mitigation provider
capability.";
}
enum "dots-client-withdrawn-mitigation" {
value 5;
description
"DOTS client has withdrawn the mitigation
request and the mitigation is active but
terminating.";
}
enum "attack-mitigation-terminated" {
value 6;
description
"Attack mitigation is now terminated.";
}
enum "attack-mitigation-withdrawn" {
value 7;
description
"Attack mitigation is withdrawn.";
}
enum "attack-mitigation-rejected" {
value 8;
description
"Attack mitigation is rejected.";
}
}
config false;
description
"Indicates the status of a mitigation request.
It must be included in responses only.";
}
container conflict-information {
config false;
description
"Indicates that a conflict is detected.
Must only be used for responses.";
leaf conflict-status {
type enumeration {
enum "request-inactive-other-active" {
value 1;
description
"DOTS Server has detected conflicting mitigation
requests from different DOTS clients.
This mitigation request is currently inactive
until the conflicts are resolved. Another
mitigation request is active.";
}
enum "request-active" {
value 2;
description
"DOTS Server has detected conflicting mitigation
requests from different DOTS clients.
This mitigation request is currently active.";
}
enum "all-requests-inactive" {
value 3;
description
"DOTS Server has detected conflicting mitigation
requests from different DOTS clients. All
conflicting mitigation requests are inactive.";
}
}
description
"Indicates the conflict status.";
}
leaf conflict-cause {
type enumeration {
enum "overlapping-targets" {
value 1;
description
"Overlapping targets. conflict-scope provides
more details about the exact conflict.";
}
enum "conflict-with-whitelist" {
value 2;
description
"Conflicts with an existing white list.
This code is returned when the DDoS mitigation
detects that some of the source addresses/prefixes
listed in the white list ACLs are actually
attacking the target.";
}
enum "cuid-collision" {
value 3;
description
"Conflicts with the cuid used by another
DOTS client.";
}
}
description
"Indicates the cause of the conflict.";
}
leaf retry-timer {
type uint32;
units "seconds";
description
"The DOTS client must not re-send the
same request that has a conflict before the expiry of
this timer.";
}
container conflict-scope {
description
"Provides more information about the conflict scope.";
uses target {
when "../conflict-cause = 'overlapping-targets'";
}
leaf-list alias-name {
when "../../conflict-cause = 'overlapping-targets'";
type string;
description
"Conflicting alias-name.";
}
list acl-list {
when "../../conflict-cause = 'conflict-with-whitelist'";
key "acl-name";
description
"List of conflicting ACLs as defined in the DOTS data
channel. These ACLs are uniquely defined by
cuid and acl-name.";
leaf acl-name {
type leafref {
path "/ietf-acl:access-lists/ietf-acl:acl/" +
"ietf-acl:name";
}
description
"Reference to the conflicting ACL name bound to
a DOTS client.";
}
leaf acl-type {
type leafref {
path "/ietf-acl:access-lists/ietf-acl:acl/" +
"ietf-acl:type";
}
description
"Reference to the conflicting ACL type bound to
a DOTS client.";
}
}
}
}
leaf bytes-dropped {
type yang:zero-based-counter64;
units "bytes";
config false;
description
"The total dropped byte count for the mitigation
request since the attack mitigation is triggered.
The count wraps around when it reaches the maximum value
of counter64 for dropped bytes.";
}
leaf bps-dropped {
type yang:zero-based-counter64;
config false;
description
"The average number of dropped bits per second for
the mitigation request since the attack
mitigation is triggered. This should be a
five-minute average.";
}
leaf pkts-dropped {
type yang:zero-based-counter64;
config false;
description
"The total number of dropped packet count for the
mitigation request since the attack mitigation is
triggered. The count wraps around when it reaches
the maximum value of counter64 for dropped packets.";
}
leaf pps-dropped {
type yang:zero-based-counter64;
config false;
description
"The average number of dropped packets per second
for the mitigation request since the attack
mitigation is triggered. This should be a
five-minute average.";
}
leaf attack-status {
type enumeration {
enum "under-attack" {
value 1;
description
"The DOTS client determines that it is still under
attack.";
}
enum "attack-successfully-mitigated" {
value 2;
description
"The DOTS client determines that the attack is
successfully mitigated.";
}
}
description
"Indicates the status of an attack as seen by the
DOTS client.";
}
}
}
grouping config-parameters {
description
"Subset of DOTS signal channel session configuration.";
container heartbeat-interval {
description
"DOTS agents regularly send heartbeats to each other
after mutual authentication is successfully
completed in order to keep the DOTS signal channel
open.";
leaf max-value {
type uint16;
units "seconds";
config false;
description
"Maximum acceptable heartbeat-interval value.";
}
leaf min-value {
type uint16;
units "seconds";
config false;
description
"Minimum acceptable heartbeat-interval value.";
}
leaf current-value {
type uint16;
units "seconds";
default "30";
description
"Current heartbeat-interval value.
'0' means that heartbeat mechanism is deactivated.";
}
}
container missing-hb-allowed {
description
"Maximum number of missing heartbeats allowed.";
leaf max-value {
type uint16;
config false;
description
"Maximum acceptable missing-hb-allowed value.";
}
leaf min-value {
type uint16;
config false;
description
"Minimum acceptable missing-hb-allowed value.";
}
leaf current-value {
type uint16;
default "5";
description
"Current missing-hb-allowed value.";
}
}
container max-retransmit {
description
"Maximum number of retransmissions of a Confirmable
message.";
leaf max-value {
type uint16;
config false;
description
"Maximum acceptable max-retransmit value.";
}
leaf min-value {
type uint16;
config false;
description
"Minimum acceptable max-retransmit value.";
}
leaf current-value {
type uint16;
default "3";
description
"Current max-retransmit value.";
}
}
container ack-timeout {
description
"Initial retransmission timeout value.";
leaf max-value {
type uint16;
units "seconds";
config false;
description
"Maximum ack-timeout value.";
}
leaf min-value {
type uint16;
units "seconds";
config false;
description
"Minimum ack-timeout value.";
}
leaf current-value {
type uint16;
units "seconds";
default "2";
description
"Current ack-timeout value.";
}
}
container ack-random-factor {
description
"Random factor used to influence the timing of
retransmissions.";
leaf max-value-decimal {
type decimal64 {
fraction-digits 2;
}
config false;
description
"Maximum acceptable ack-random-factor value.";
}
leaf min-value-decimal {
type decimal64 {
fraction-digits 2;
}
config false;
description
"Minimum acceptable ack-random-factor value.";
}
leaf current-value-decimal {
type decimal64 {
fraction-digits 2;
}
default "1.5";
description
"Current ack-random-factor value.";
}
}
}
grouping signal-config {
description
"DOTS signal channel session configuration.";
leaf sid {
type uint32;
mandatory true;
description
"An identifier for the DOTS signal channel
session configuration data.";
}
container mitigating-config {
description
"Configuration parameters to use when a mitigation
is active.";
uses config-parameters;
}
container idle-config {
description
"Configuration parameters to use when no mitigation
is active.";
uses config-parameters;
}
leaf trigger-mitigation {
type boolean;
default "true";
description
"If false, then mitigation is triggered
only when the DOTS server channel session is lost.";
}
leaf config-interval {
type uint32;
units "seconds";
default "3600";
config false;
description
"This parameter is returned by a DOTS server to
a requesting DOTS client to indicate the time interval
after which the DOTS client must contact the DOTS
server in order to retrieve the signal channel
configuration data.
This mechanism allows the update of the configuration
data if a change occurs.
For example, the new configuration may instruct
a DOTS client to cease heartbeats or reduce
heartbeat frequency.
'0' is used to disable this refresh mechanism.";
}
}
grouping redirected-signal {
description
"Grouping for the redirected signaling.";
leaf alt-server {
type string;
config false;
mandatory true;
description
"FQDN of an alternate server.";
}
list alt-server-record {
key "addr";
config false;
description
"List of records for the alternate server.";
leaf addr {
type inet:ip-address;
description
"An IPv4 or IPv6 address identifying the server.";
}
leaf ttl {
type uint32;
description
"TTL associated with this record.";
}
}
}
/*
* Main Container for DOTS Signal Channel
*/
container dots-signal {
description
"Main container for DOTS signal message.
A DOTS signal message can be a mitigation, a configuration,
or a redirected signal message.";
choice message-type {
description
"Can be a mitigation, a configuration, or a redirect
message.";
case mitigation-scope {
description
"Mitigation scope of a mitigation message.";
uses mitigation-scope;
}
case signal-config {
description
"Configuration message.";
uses signal-config;
}
case redirected-signal {
description
"Redirected signaling.";
uses redirected-signal;
}
}
}
}