A YANG Data Model for Terminal Access Controller Access-Control System Plus (TACACS+)

TACACS+ Client Module This module uses types and groupings defined in , , , , , , , and . The module augments . The module also cites , , , and . WG List: Editor: Mohamed Boucadair Author: Bo Wu Author: Guangying Zheng "; description "This module provides configuration of TACACS+ clients. The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here. Copyright (c) 2024 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 Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://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 2024-12-11 { description "This revision adds TLS support"; reference "RFC XXXX: A YANG Model for Terminal Access Controller Access-Control System Plus (TACACS+)"; } revision 2021-08-05 { description "Initial revision."; reference "RFC 9105: A YANG Data Model for Terminal Access Controller Access-Control System Plus (TACACS+)"; } feature credential-reference { description "Indicates whether service credentials references are supported."; } identity tacacs-plus { base sys:authentication-method; description "Indicates AAA operation using TACACS+."; } typedef tacacs-plus-server-type { type bits { bit authentication { description "Indicates that the TACACS+ server is providing authentication services."; } bit authorization { description "Indicates that the TACACS+ server is providing authorization services."; } bit accounting { description "Indicates that the TACACS+ server is providing accounting services."; } } description "tacacs-plus-server-type can be set to authentication/authorization/accounting or any combination of the three types."; } typedef client-credentials-ref { type leafref { path "/sys:system/sys-tcs-plus:tacacs-plus" + "/sys-tcs-plus:client-credentials/sys-tcs-plus:id"; } description "Defines a type to reference client credentials."; } typedef server-credentials-ref { type leafref { path "/sys:system/sys-tcs-plus:tacacs-plus" + "/sys-tcs-plus:server-credentials/sys-tcs-plus:id"; } description "Defines a type to reference server credentials."; } grouping statistics { description "Grouping for TACACS+ statistics attributes."; container statistics { config false; description "A collection of server-related statistics objects."; leaf connection-opens { type yang:counter64; description "Number of new connection requests sent to the server, e.g., socket open."; } leaf connection-closes { type yang:counter64; description "Number of connection close requests sent to the server, e.g., socket close."; } leaf connection-aborts { type yang:counter64; description "Number of aborted connections to the server. These do not include connections that are closed gracefully."; } leaf connection-failures { type yang:counter64; description "Number of connection failures to the server."; } leaf connection-timeouts { type yang:counter64; description "Number of connection timeouts to the server."; } leaf messages-sent { type yang:counter64; description "Number of messages sent to the server."; } leaf messages-received { type yang:counter64; description "Number of messages received from the server."; } leaf errors-received { type yang:counter64; description "Number of error messages received from the server."; } leaf sessions { type yang:counter64; description "Number of TACACS+ sessions completed with the server. If the Single Connection Mode was NOT enabled, the number of sessions is the same as the number of 'connection-closes'. If the Mode was enabled, a single TCP connection may contain multiple TACACS+ sessions."; } } } grouping certificate { description "Specifies the client identity using a certificate."; uses "ks:inline-or-keystore-end-entity-cert-with-key-" + "grouping" { refine "inline-or-keystore/inline/inline-definition" { must 'not(public-key-format) or derived-from-or-self' + '(public-key-format, "ct:subject-public-key-' + 'info-format")'; } refine "inline-or-keystore/central-keystore/" + "central-keystore-reference/asymmetric-key" { must 'not(deref(.)/../ks:public-key-format) or ' + 'derived-from-or-self(deref(.)/../ks:public-' + 'key-format, "ct:subject-public-key-info-' + 'format")'; } } } grouping raw-private-key { description "Specifies the client identity using a raw private key."; uses ks:inline-or-keystore-asymmetric-key-grouping { refine "inline-or-keystore/inline/inline-definition" { must 'not(public-key-format) or derived-from-or-self' + '(public-key-format, "ct:subject-public-key-' + 'info-format")'; } refine "inline-or-keystore/central-keystore/" + "central-keystore-reference" { must 'not(deref(.)/../ks:public-key-format) or ' + 'derived-from-or-self(deref(.)/../ks:public-' + 'key-format, "ct:subject-public-key-info-format")'; } } } grouping tls13-epsk { description "An External Pre-Shared Key (EPSK) is established or provisioned out-of-band, i.e., not from a TLS connection. An EPSK is a tuple of (Base Key, External Identity, Hash). When PSKs are provisioned out of band, the PSK identity and the Key Derivation Function (KDF) hash algorithm to be used with the PSK must also be provisioned."; reference "RFC 8446: The Transport Layer Security (TLS) Protocol Version 1.3, Section 4.2.11 RFC 9257: Guidance for External Pre-Shared Key (PSK) Usage in TLS, Section 6 RFC 9258: Importing External Pre-Shared Keys (PSKs) for TLS 1.3, Section 5.1"; uses ks:inline-or-keystore-symmetric-key-grouping; leaf external-identity { type string; mandatory true; description "A sequence of bytes used to identify an EPSK. A label for a pre-shared key established externally."; reference "RFC 8446: The Transport Layer Security (TLS) Protocol Version 1.3, Section 4.2.11 RFC 9257: Guidance for External Pre-Shared Key (PSK) Usage in TLS, Section 4.1"; } leaf hash { type tlscmn:epsk-supported-hash; default "sha-256"; description "For externally established PSKs, the Hash algorithm must be set when the PSK is established or default to SHA-256 if no such algorithm is defined."; reference "RFC 8446: The Transport Layer Security (TLS) Protocol Version 1.3, Section 4.2.11"; } leaf context { type string; description "The context used to determine the EPSK, if any exists. For example, context may include information about peer roles or identities to mitigate Selfie-style reflection attacks."; reference "RFC 9258: Importing External Pre-Shared Keys (PSKs) for TLS 1.3, Section 5.1 "; } leaf target-protocol { type uint16; description "Specifies the protocol for which a PSK is imported for use."; reference "RFC 9258: Importing External Pre-Shared Keys (PSKs) for TLS 1.3, Section 3 "; } leaf target-kdf { type uint16; description "The KDF for which a PSK is imported for use."; reference "RFC 9258: Importing External Pre-Shared Keys (PSKs) for TLS 1.3, Section 3"; } } grouping client-identity { description "Identity credentials that the TLS client may present when establishing a connection to a TLS server. When configured, and requested by the TLS server when establishing a TLS session, these credentials are passed in the Certificate message."; reference "RFC 8446: The Transport Layer Security (TLS) Protocol Version 1.3, Section 4.4.2"; nacm:default-deny-write; choice auth-type { //default "certificate"; //mandatory true; description "A choice amongst authentication types, of which one must be enabled and selected."; case certificate { container certificate { description "Specifies the client identity using a certificate."; uses certificate; } } case raw-public-key { if-feature "tlsc:client-ident-raw-public-key"; container raw-private-key { description "Specifies the client identity using RPK."; uses raw-private-key; } } case tls13-epsk { if-feature "tlsc:client-ident-tls13-epsk"; container tls13-epsk { description "An EPSK is established or provisioned out-of-band."; uses tls13-epsk; } } } } grouping client-identity-with-ref { description "Identity credentials that the TLS client may present when establishing a connection to a TLS server. When configured, and requested by the TLS server when establishing a TLS session, these credentials are passed in the Certificate message."; choice ref-or-explicit { description "A choice between a reference of explicit configuration."; case ref { description "Provides a reference."; leaf credentials-reference { if-feature credential-reference; type sys-tcs-plus:client-credentials-ref; description "Specifies the client credentials reference."; } } case explicit { description "Explicit configuration."; uses client-identity; } } } grouping server-authentication { description "Specifies how the TLS client can authenticate TLS servers. Any combination of credentials is additive and unordered."; nacm:default-deny-write; container ca-certs { presence "Indicates that Certification Authority (CA) certificates have been configured. This statement is present so the mandatory descendant nodes do not imply that this node must be configured."; description "A set of CA certificates used by the TLS client to authenticate TLS server certificates. A server certificate is authenticated if it has a valid chain of trust to a configured CA certificate."; reference "RFC 9641: A YANG Data Model for a Truststore"; uses ts:inline-or-truststore-certs-grouping; } container ee-certs { presence "Indicates that End Entity (EE) certificates have been configured. This statement is present so the mandatory descendant nodes do not imply that this node must be configured."; description "A set of server certificates (i.e., end entity certificates) used by the TLS client to authenticate certificates presented by TLS servers. A server certificate is authenticated if it is an exact match to a configured server certificate."; reference "RFC 9641: A YANG Data Model for a Truststore"; uses ts:inline-or-truststore-certs-grouping; } container raw-public-keys { if-feature "tlsc:server-auth-raw-public-key"; presence "Indicates that raw public keys have been configured. This statement is present so the mandatory descendant nodes do not imply that this node must be configured."; description "A set of raw public keys used by the TLS client to authenticate raw public keys presented by the TLS server. A raw public key is authenticated if it is an exact match to a configured raw public key."; reference "RFC 9641: A YANG Data Model for a Truststore"; uses ts:inline-or-truststore-public-keys-grouping { refine "inline-or-truststore/inline/inline-definition/" + "public-key" { must 'derived-from-or-self(public-key-format,' + ' "ct:subject-public-key-info-format")'; } refine "inline-or-truststore/central-truststore/" + "central-truststore-reference" { must 'not(deref(.)/../ts:public-key/ts:public-key-' + 'format[not(derived-from-or-self(., "ct:subject-' + 'public-key-info-format"))])'; } } } leaf tls13-epsks { if-feature "tlsc:server-auth-tls13-epsk"; type empty; description "Indicates that the TLS client can authenticate TLS servers using configured external PSKs."; } } grouping server-authentication-with-ref { description "Specifies how the TLS client can authenticate TLS servers."; choice ref-or-explicit { description "A choice between a reference of explicit configuration."; case ref { description "Provides a reference."; leaf credentials-reference { if-feature credential-reference; type sys-tcs-plus:server-credentials-ref; description "Specifies the server credentials reference."; } } case explicit { description "Explicit configuration."; uses server-authentication; } } } grouping hello-params { description "Configurable parameters for the TLS hello message."; nacm:default-deny-write; uses tlscmn:hello-params-grouping { refine "tls-versions/min" { must "not(derived-from-or-self(current(), " + "'tlscmn:tls12'))" { error-message "TLS 1.2 is not supported as min TLS version"; } } refine "tls-versions/max" { must "not(derived-from-or-self(current(), " + "'tlscmn:tls12'))" { error-message "TLS 1.2 is not supported as max TLS version"; } } } } grouping tls-client { description "A grouping for configuring a TLS client without any consideration for how an underlying TCP session is established."; container client-identity { presence "Indicates that a TLS-level client identity has been configured. This statement is present so the mandatory descendant do not imply that this node must be configured."; description "Identity credentials the TLS client may present when establishing a connection to a TLS server."; //uses client-identity; uses client-identity-with-ref; } container server-authentication { must 'ca-certs or ee-certs or raw-public-keys or tls13-epsks'; description "Specifies how the TLS client can authenticate TLS servers."; //uses server-authentication; uses server-authentication-with-ref; } container hello-params { if-feature "tlscmn:hello-params"; description "Configurable parameters for the TLS hello message."; uses hello-params; } } grouping tls-grouping-reuse { description "A grouping for TLS with TLS1.2 and keepalive removed."; uses tlsc:tls-client-grouping { refine "client-identity/auth-type/tls12-psk" { if-feature "not tlsc:client-ident-tls12-psk"; } refine "server-authentication/tls12-psks" { if-feature "not tlsc:server-auth-tls12-psk"; } refine "hello-params/tls-versions/min" { must "not(derived-from-or-self(current(), " + "'tlscmn:tls12'))" { error-message "TLS 1.2 is not supported as min TLS version"; } } refine "hello-params/tls-versions/max" { must "not(derived-from-or-self(current(), " + "'tlscmn:tls12'))" { error-message "TLS 1.2 is not supported as max TLS version"; } } refine "keepalives" { if-feature "not tlsc:tls-client-keepalives"; } } } grouping tacacs-plus { description "Grouping for TACACS+ attributes."; container tacacs-plus { must "not(derived-from-or-self(../sys:authentication" + "/sys:user-authentication-order, 'tacacs-plus'))" + " or bit-is-set(server/server-type,'authentication')" { error-message "When 'tacacs-plus' is used as a system authentication method, a TACACS+ authentication server must be configured."; description "When 'tacacs-plus' is used as an authentication method, a TACACS+ server must be configured."; } description "Container for TACACS+ configurations and operations."; list client-credentials { if-feature credential-reference; key "id"; description "Identity credentials the TLS client may present when establishing a connection to a TLS server. A list of client credentials to be referenced."; nacm:default-deny-write; leaf id { type string; description "A credential identifier."; } uses client-identity; } list server-credentials { if-feature credential-reference; key "id"; description "Identity credentials the TLS client may present when establishing a connection to a TLS server."; nacm:default-deny-write; leaf id { type string; description "A credential identifier."; } uses server-authentication; } list server { key "name"; ordered-by user; description "List of TACACS+ servers used by the device."; leaf name { type string; description "An arbitrary name for the TACACS+ server."; } leaf server-type { type tacacs-plus-server-type; mandatory true; description "Server type: authentication/authorization/accounting and various combinations."; } leaf domain-name { type inet:domain-name; description "Provides a domain name of the TACACS+ server."; } leaf address { type inet:host; mandatory true; description "The address of the TACACS+ server."; } leaf port { type inet:port-number; default "49"; // to be replaced by TACACS-TLS-PORT description "The port number of TACACS+ Sserver port number."; } choice security { mandatory true; description "Security mechanism between TACACS+ client and server. This is modeled as a YANG 'choice' so that it can be augmented by a YANG module in a backwards-compatible manner."; case tls { description "TLS is used."; uses tls-client; //uses client-identity-with-ref; } case obfuscation { leaf shared-secret { type string { length "1..max"; } description "The shared secret, which is known to both the TACACS+ client and server. TACACS+ server administrators SHOULD configure a shared secret with a minimum length of 16 characters. It is highly recommended that this shared secret is at least 32 characters long and sufficiently complex with a mix of different character types, i.e., upper case, lower case, numeric, and punctuation. Note that this security mechanism is best described as 'obfuscation' and not 'encryption' as it does not provide any meaningful integrity, privacy, or replay protection."; reference "RFC 8907: The TACACS+ Protocol"; nacm:default-deny-all; } } } choice source-type { description "The source address type for outbound TACACS+ packets."; case source-ip { leaf source-ip { type inet:ip-address; description "Specifies the source IP address for TACACS+ outbound packets."; } } case source-interface { leaf source-interface { type if:interface-ref; description "Specifies the interface from which the IP address is derived for use as the source for the outbound TACACS+ packet."; } } } leaf vrf-instance { type leafref { path "/ni:network-instances/ni:network-instance/ni:name"; } description "Specifies the VPN Routing and Forwarding (VRF) instance to use to communicate with the TACACS+ server."; reference "RFC 8529: YANG Data Model for Network Instances"; } leaf single-connection { type boolean; default "false"; description "Indicates whether the Single Connection Mode is enabled for the server. By default, the Single Connection Mode is disabled."; } leaf timeout { type uint16 { range "1..max"; } units "seconds"; default "5"; description "The number of seconds the device will wait for a response from each TACACS+ server before trying with a different server."; } uses statistics; } } } augment "/sys:system" { description "Augments the system model with the tacacs-plus model."; uses tacacs-plus; } } ]]>