draft-ietf-alto-unified-props-new-03.txt   draft-ietf-alto-unified-props-new-04.txt 
ALTO WG W. Roome ALTO WG W. Roome
Internet-Draft Nokia Bell Labs Internet-Draft Nokia Bell Labs
Intended status: Standards Track S. Chen Intended status: Standards Track S. Chen
Expires: September 6, 2018 Tongji University Expires: December 31, 2018 Tongji University
S. Randriamasy S. Randriamasy
Nokia Bell Labs Nokia Bell Labs
Y. Yang Y. Yang
Yale University Yale University
J. Zhang J. Zhang
Tongji University Tongji University
March 5, 2018 June 29, 2018
Unified Properties for the ALTO Protocol Unified Properties for the ALTO Protocol
draft-ietf-alto-unified-props-new-03 draft-ietf-alto-unified-props-new-04
Abstract Abstract
This document extends the Application-Layer Traffic Optimization This document extends the Application-Layer Traffic Optimization
(ALTO) Protocol [RFC7285] by generalizing the concept of "endpoint (ALTO) Protocol [RFC7285] by generalizing the concept of "endpoint
properties" to other entity domains, and by presenting those properties" to domains of other entities, and by presenting those
properties as maps, similar to the network and cost maps in ALTO. properties as maps, similar to the network and cost maps in ALTO.
Requirements Language Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [RFC2119]. document are to be interpreted as described in RFC 2119 [RFC2119].
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 6, 2018. This Internet-Draft will expire on December 31, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Definitions and Concepts . . . . . . . . . . . . . . . . . . 4 2. Definitions and Concepts . . . . . . . . . . . . . . . . . . 4
2.1. Entity . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.1. Entity . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2. Domain . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.2. Entity Domain . . . . . . . . . . . . . . . . . . . . . . 5
2.3. Domain Name . . . . . . . . . . . . . . . . . . . . . . . 4 2.3. Domain Name . . . . . . . . . . . . . . . . . . . . . . . 5
2.4. Entity Address . . . . . . . . . . . . . . . . . . . . . 5 2.4. Entity Address . . . . . . . . . . . . . . . . . . . . . 5
2.5. Property Name . . . . . . . . . . . . . . . . . . . . . . 5 2.5. Property Name . . . . . . . . . . . . . . . . . . . . . . 6
2.6. Hierarchy and Inheritance . . . . . . . . . . . . . . . . 6 2.6. Hierarchy and Inheritance . . . . . . . . . . . . . . . . 6
2.7. Relationship with Other ALTO Resources . . . . . . . . . 6 2.7. Relationship with Other ALTO Resources . . . . . . . . . 6
3. Entity Domains . . . . . . . . . . . . . . . . . . . . . . . 7 3. Entity Domains . . . . . . . . . . . . . . . . . . . . . . . 7
3.1. Internet Address Domains . . . . . . . . . . . . . . . . 7 3.1. Internet Address Domains . . . . . . . . . . . . . . . . 7
3.1.1. IPv4 Domain . . . . . . . . . . . . . . . . . . . . . 7 3.1.1. IPv4 Domain . . . . . . . . . . . . . . . . . . . . . 7
3.1.2. IPv6 Domain . . . . . . . . . . . . . . . . . . . . . 7 3.1.2. IPv6 Domain . . . . . . . . . . . . . . . . . . . . . 8
3.1.3. Hierarchy and Inheritance of ipv4/ipv6 Domains . . . 8 3.1.3. Hierarchy and Inheritance of ipv4/ipv6 Domains . . . 8
3.1.4. Relationship to Network Maps . . . . . . . . . . . . 9 3.1.4. Relationship to Network Maps . . . . . . . . . . . . 9
3.2. PID Domain . . . . . . . . . . . . . . . . . . . . . . . 10 3.2. PID Domain . . . . . . . . . . . . . . . . . . . . . . . 10
3.2.1. Domain Name . . . . . . . . . . . . . . . . . . . . . 10 3.2.1. Domain Name . . . . . . . . . . . . . . . . . . . . . 10
3.2.2. Domain-Specific Entity Addresses . . . . . . . . . . 10 3.2.2. Domain-Specific Entity Addresses . . . . . . . . . . 10
3.2.3. Hierarchy and Inheritance . . . . . . . . . . . . . . 10 3.2.3. Hierarchy and Inheritance . . . . . . . . . . . . . . 10
3.2.4. Relationship To Internet Addresses Domains . . . . . 10 3.2.4. Relationship To Internet Addresses Domains . . . . . 10
3.3. Internet Address Properties vs. PID Properties . . . . . 10 3.3. Internet Address Properties vs. PID Properties . . . . . 10
4. Property Map Resource . . . . . . . . . . . . . . . . . . . . 11 4. Property Map Resource . . . . . . . . . . . . . . . . . . . . 11
4.1. Media Type . . . . . . . . . . . . . . . . . . . . . . . 11 4.1. Media Type . . . . . . . . . . . . . . . . . . . . . . . 11
4.2. HTTP Method . . . . . . . . . . . . . . . . . . . . . . . 11 4.2. HTTP Method . . . . . . . . . . . . . . . . . . . . . . . 11
4.3. Accept Input Parameters . . . . . . . . . . . . . . . . . 11 4.3. Accept Input Parameters . . . . . . . . . . . . . . . . . 11
4.4. Capabilities . . . . . . . . . . . . . . . . . . . . . . 11 4.4. Capabilities . . . . . . . . . . . . . . . . . . . . . . 11
4.5. Uses . . . . . . . . . . . . . . . . . . . . . . . . . . 11 4.5. Uses . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.6. Response . . . . . . . . . . . . . . . . . . . . . . . . 12 4.6. Response . . . . . . . . . . . . . . . . . . . . . . . . 12
5. Filtered Property Map Resource . . . . . . . . . . . . . . . 12 5. Filtered Property Map Resource . . . . . . . . . . . . . . . 13
5.1. Media Type . . . . . . . . . . . . . . . . . . . . . . . 13 5.1. Media Type . . . . . . . . . . . . . . . . . . . . . . . 13
5.2. HTTP Method . . . . . . . . . . . . . . . . . . . . . . . 13 5.2. HTTP Method . . . . . . . . . . . . . . . . . . . . . . . 13
5.3. Accept Input Parameters . . . . . . . . . . . . . . . . . 13 5.3. Accept Input Parameters . . . . . . . . . . . . . . . . . 13
5.4. Capabilities . . . . . . . . . . . . . . . . . . . . . . 13 5.4. Capabilities . . . . . . . . . . . . . . . . . . . . . . 14
5.5. Uses . . . . . . . . . . . . . . . . . . . . . . . . . . 14 5.5. Uses . . . . . . . . . . . . . . . . . . . . . . . . . . 14
5.6. Response . . . . . . . . . . . . . . . . . . . . . . . . 14 5.6. Response . . . . . . . . . . . . . . . . . . . . . . . . 14
6. Impact on Legacy ALTO Servers and ALTO Clients . . . . . . . 14 6. Impact on Legacy ALTO Servers and ALTO Clients . . . . . . . 14
6.1. Impact on Endpoint Property Service . . . . . . . . . . . 14 6.1. Impact on Endpoint Property Service . . . . . . . . . . . 15
6.2. Impact on Resource-Specific Properties . . . . . . . . . 14 6.2. Impact on Resource-Specific Properties . . . . . . . . . 15
6.3. Impact on the "pid" Property . . . . . . . . . . . . . . 15 6.3. Impact on the pid Property . . . . . . . . . . . . . . . 15
6.4. Impact on Other Properties . . . . . . . . . . . . . . . 15 6.4. Impact on Other Properties . . . . . . . . . . . . . . . 16
7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 15 7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 16
7.1. Network Map . . . . . . . . . . . . . . . . . . . . . . . 15 7.1. Network Map . . . . . . . . . . . . . . . . . . . . . . . 16
7.2. Property Definitions . . . . . . . . . . . . . . . . . . 16 7.2. Property Definitions . . . . . . . . . . . . . . . . . . 16
7.3. Information Resource Directory (IRD) . . . . . . . . . . 16 7.3. Information Resource Directory (IRD) . . . . . . . . . . 16
7.4. Property Map Example . . . . . . . . . . . . . . . . . . 18 7.4. Property Map Example . . . . . . . . . . . . . . . . . . 18
7.5. Filtered Property Map Example #1 . . . . . . . . . . . . 18 7.5. Filtered Property Map Example #1 . . . . . . . . . . . . 19
7.6. Filtered Property Map Example #2 . . . . . . . . . . . . 19 7.6. Filtered Property Map Example #2 . . . . . . . . . . . . 20
7.7. Filtered Property Map Example #3 . . . . . . . . . . . . 20 7.7. Filtered Property Map Example #3 . . . . . . . . . . . . 21
7.8. Filtered Property Map Example #4 . . . . . . . . . . . . 21 7.8. Filtered Property Map Example #4 . . . . . . . . . . . . 22
8. Security Considerations . . . . . . . . . . . . . . . . . . . 22 8. Security Considerations . . . . . . . . . . . . . . . . . . . 24
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 23 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 24
9.1. application/alto-* Media Types . . . . . . . . . . . . . 23 9.1. application/alto-* Media Types . . . . . . . . . . . . . 24
9.2. ALTO Entity Domain Registry . . . . . . . . . . . . . . . 24 9.2. ALTO Entity Domain Registry . . . . . . . . . . . . . . . 25
9.3. ALTO Endpoint Property Type Registry . . . . . . . . . . 26 9.2.1. Consistency Procedure between ALTO Address Type
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 26 Registry and ALTO Entity Domain Registry . . . . . . 26
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 27 9.2.2. ALTO Entity Domain Registration Process . . . . . . . 27
9.3. ALTO Endpoint Property Type Registry . . . . . . . . . . 28
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 28
10.1. Normative References . . . . . . . . . . . . . . . . . . 28
10.2. Informative References . . . . . . . . . . . . . . . . . 29
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 29
1. Introduction 1. Introduction
The ALTO protocol [RFC7285] introduced the concept of "properties" The ALTO protocol [RFC7285] introduced the concept of "properties"
attached to "endpoint addresses", and defined the Endpoint Property attached to "endpoint addresses", and defined the Endpoint Property
Service (EPS) to allow clients to retrieve those properties. While Service (EPS) to allow clients to retrieve those properties. While
useful, the EPS, as defined in RFC7285, has at least two limitations. useful, the EPS, as defined in [RFC7285], has at least two
limitations.
First, it only allows properties to be associated with a particular First, it only allows properties to be associated with a particular
domain of entities, namely individual IP addresses. It is reasonable domain of entities, namely individual IP addresses. It is reasonable
to think that collections of endpoints, as defined by CIDRs [RFC4632] to think that collections of endpoints, as defined by CIDRs [RFC4632]
or PIDs, may also have properties. The EPS cannot be extended to new or PIDs, may also have properties. The EPS cannot be extended to new
entity domains. Instead, new services, with new request and response entity domains. Instead, new services, with new request and response
messages, would have to be defined for each new entity domain. messages, would have to be defined for each new entity domain.
Second, the EPS is only defined as a POST-mode service. Clients must Second, the EPS is only defined as a POST-mode service. Clients must
request the properties for an explicit set of addresses. By request the properties for an explicit set of addresses. By
skipping to change at page 4, line 23 skipping to change at page 4, line 28
This document proposes a new approach to retrieve ALTO properties. This document proposes a new approach to retrieve ALTO properties.
Specifically, it defines two new resource types, namely Property Maps Specifically, it defines two new resource types, namely Property Maps
(see Section 4) and Filtered Property Maps (see Section 5). The (see Section 4) and Filtered Property Maps (see Section 5). The
former are GET-mode resources which return the property values for former are GET-mode resources which return the property values for
all entities in a domain, and are analogous to the ALTO's Network all entities in a domain, and are analogous to the ALTO's Network
Maps and Cost Maps. The latter are POST-mode resources which return Maps and Cost Maps. The latter are POST-mode resources which return
the values for a set of properties and entities requested by the the values for a set of properties and entities requested by the
client, and are analogous to the ALTO's Filtered Network Maps and client, and are analogous to the ALTO's Filtered Network Maps and
Filtered Cost Maps. Filtered Cost Maps.
Entity domains and property names are extensible. New domains can be Additionally, this document introduces ALTO Entity Domains, where
defined without revising the messages defined in this document, in entities extend the concept of endpoints to objects that may be
the same way that new cost metrics and new endpoint properties can be endpoints as defined in [RFC7285] but also, for example, PIDs,
defined without revising the messages defined by the ALTO protocol. Abstract Network Elements as defined in [I-D.ietf-alto-path-vector]
or cells. As a consequence, ALTO Entity Domains are a super-set of
ALTO Address Types and their relation is specified in Section 9.2.1.
Entity domains and property names are extensible. New entity domains
can be defined without revising the messages defined in this
document, in the same way that new cost metrics and new endpoint
properties can be defined without revising the messages defined by
the ALTO protocol.
This proposal would subsume the Endpoint Property Service defined in This proposal would subsume the Endpoint Property Service defined in
RFC7285, although that service may be retained for legacy clients [RFC7285], although that service may be retained for legacy clients
(see Section 6). (see Section 6).
2. Definitions and Concepts 2. Definitions and Concepts
2.1. Entity 2.1. Entity
An entity is an object with a (possibly empty) set of properties. The entity is an extended concept of the endpoint defined in
Every entity is in a domain, such as the IPv4 and IPv6 domains, and Section 2.1 of [RFC7285]. An entity is an object with a (possibly
has a unique address. empty) set of properties. Every entity is in a domain, such as the
IPv4 and IPv6 domains, and has a unique address.
2.2. Domain 2.2. Entity Domain
A domain is a family of entities. Two examples are the Internet An entity domain is a family of entities. Two examples are the
address and PID domain (see Section 3.1 and Section 3.2) that this Internet address and PID domain (see Section 3.1 and Section 3.2)
document will define. that this document will define.
2.3. Domain Name 2.3. Domain Name
Each domain has a unique name. A domain name MUST be no more than 32 Each entity domain has a unique name. A domain name MUST be no more
characters, and MUST NOT contain characters other than US-ASCII than 32 characters, and MUST NOT contain characters other than US-
alphanumeric characters (U+0030-U+0039, U+0041-U+005A, and ASCII alphanumeric characters (U+0030-U+0039, U+0041-U+005A, and
U+0061-U+007A), hyphen ('-', U+002D), and low line ('_', U+005F). U+0061-U+007A), hyphen ("-", U+002D), and low line ("_", U+005F).
For example, the names "ipv4" and "ipv6" identify objects in the For example, the names "ipv4" and "ipv6" identify objects in the
Internet address domain (see Section 3.1). Internet address domain (see Section 3.1).
The type DomainName is used in this document to denote a JSON string The type DomainName is used in this document to denote a JSON string
with a domain name in this format. with a domain name in this format.
Domain names MUST be registered with the IANA, and the format of the Domain names MUST be registered with the IANA, and the format of the
entity addresses in that domain, as well as any hierarchical or entity addresses in that entity domain, as well as any hierarchical
inheritance rules for those entities, MUST be specified at the same or inheritance rules for those entities, MUST be specified at the
time. same time.
2.4. Entity Address 2.4. Entity Address
Each entity has a unique address of the format: Each entity has a unique address of the format:
domain-name : domain-specific-entity-address domain-name : domain-specific-entity-address
Examples from the IP domain include individual addresses such as Examples from the IP domain include individual addresses such as
"ipv4:192.0.2.14" and "ipv6:2001:db8::12", as well as address blocks "ipv4:192.0.2.14" and "ipv6:2001:db8::12", as well as address blocks
such as "ipv4:192.0.2.0/26" and "ipv6:2001:db8::1/48". such as "ipv4:192.0.2.0/26" and "ipv6:2001:db8::1/48".
The type EntityAddr is used in this document to denote a JSON string The type EntityAddr is used in this document to denote a JSON string
with an entity address in this format. with an entity address in this format.
The format of the second part of an entity address depends on the The format of the second part of an entity address depends on the
domain, and MUST be specified when registering a new domain. entity domain, and MUST be specified when registering a new entity
Addresses MAY be hierarchical, and properties MAY be inherited based domain. Addresses MAY be hierarchical, and properties MAY be
on that hierarchy. Again, the rules defining any hierarchy or inherited based on that hierarchy. Again, the rules defining any
inheritance MUST be defined when the domain is registered. hierarchy or inheritance MUST be defined when the entity domain is
registered.
Note that an entity address MAY have different textual Note that an entity address MAY have different textual
representations, for a given domain. For example, the strings representations, for a given entity domain. For example, the strings
"ipv6:2001:db8::1" and "ipv6:2001:db8:0:0:0:0:0:1" refer to the same "ipv6:2001:db8::1" and "ipv6:2001:db8:0:0:0:0:0:1" refer to the same
entity. entity.
2.5. Property Name 2.5. Property Name
The space of property names associated with entities defined by this The space of property names associated with entities defined by this
document is the same as, and is shared with, the endpoint property document is the same as, and is shared with, the endpoint property
names defined by [RFC7285]. Thus entity property names are as names defined by [RFC7285]. Thus entity property names are as
defined in Section 10.8.2 of that document, and must be registered defined in Section 10.8.2 of that document, and must be registered
with the "ALTO Endpoint Property Type Registry" defined in with the "ALTO Endpoint Property Type Registry" defined in
Section 9.3 of that document. The type PropertyName denotes a JSON Section 9.3 of that document. The type PropertyName denotes a JSON
string with a property name in this format. string with a property name in this format.
This document defines uniform property names specified in a single This document defines uniform property names specified in a single
property name space rather than being scoped by a specific domain, property name space rather than being scoped by a specific entity
although some properties may only be applicable for particular domain, although some properties may only be applicable for
domains. This design decision is to enforce a design so that similar particular entity domains. This design decision is to enforce a
properties are named similarly. The interpretation of the value of a design so that similar properties are named similarly. The
property, however, may depend on the domain. For example, suppose interpretation of the value of a property, however, may depend on the
the "geo-location" property is defined as the coordinates of a point, entity domain. For example, suppose the "geo-location" property is
encoded as (say) "latitude longitude [altitude]." When applied to an defined as the coordinates of a point, encoded as (say) "latitude
entity that represents a specific host computer, such as an Internet longitude [altitude]." When applied to an entity that represents a
address, the property defines the host's location. When applied to specific host computer, such as an Internet address, the property
an entity that represents a set of computers, such as a CIDR, the defines the host's location. When applied to an entity that
property would be the location of the center of that set. If it is represents a set of computers, such as a CIDR, the property would be
necessary to represent the bounding box of a set of hosts, another the location of the center of that set. If it is necessary to
property, such as "geo-region", should be defined. represent the bounding box of a set of hosts, another property, such
as "geo-region", should be defined.
2.6. Hierarchy and Inheritance 2.6. Hierarchy and Inheritance
Entities in a given domain MAY form hierarchy based on entity Entities in a given domain MAY form hierarchy based on entity
address. Each domain MUST define its own hierarchy and inheritance address. Each entity domain MUST define its own hierarchy and
rules when registered. The hierarchy and inheritance rule makes it inheritance rules when registered. The hierarchy and inheritance
possible for an entity to inherit a property value from another rule makes it possible for an entity to inherit a property value from
entity in the same domain. If and only if the property of an entity another entity in the same domain. If and only if the property of an
is undefined, the hierarchy and inheritance rules are applied. entity is undefined, the hierarchy and inheritance rules are applied.
2.7. Relationship with Other ALTO Resources 2.7. Relationship with Other ALTO Resources
[RFC7285] recognizes that some properties MAY be specific to another [RFC7285] recognizes that some properties MAY be specific to another
ALTO resource, such as a network map. Accordingly [RFC7285] defines ALTO resource, such as a network map. Accordingly [RFC7285] defines
the concept of "resource-specific endpoint properties" (see the concept of "resource-specific endpoint properties" (see
Section 10.8.1), and indicates that dependency by prefixing the Section 10.8.1), and indicates that dependency by prefixing the
property name with the ID of the resource on which it depends. That property name with the ID of the resource on which it depends. That
document defines one resource-specific property, namely the "pid" document defines one resource-specific property, namely the "pid"
property, whose value is the name of the PID containing that endpoint property, whose value is the name of the PID containing that endpoint
in the associated network map. in the associated network map.
This document takes a different approach. Instead of defining the This document takes a different approach. Instead of defining the
dependency by qualifying the property name, this document attaches dependency by qualifying the property name, this document attaches
the dependency to the domains. Thus all properties of a specific the dependency to the entity domains. Thus all properties of a
domain depend on the same resource, the properties of another domain specific entity domain depend on the same resource, the properties of
may depend on another resource. For example, entities in the PID another entity domain may depend on another resource. For example,
domain depend on a network map. entities in the PID domain depend on a network map.
The "uses" field in an IRD entry defines the dependencies of a The "uses" field in an IRD entry defines the dependencies of a
property map resource, and the "dependent-vtags" field in a property property map resource, and the "dependent-vtags" field in a property
map response defines the dependencies of that map. These fields are map response defines the dependencies of that map. These fields are
defined in Sections 9.1.5 and 11.1 of [RFC7285], respectively. defined in Sections 9.1.5 and 11.1 of [RFC7285], respectively.
The "uses" field in an IRD entry MUST NOT include two dependent The "uses" field in an IRD entry MUST NOT include two dependent
resources with the same media type. This is similar to how [RFC7285] resources with the same media type. This is similar to how [RFC7285]
handles dependencies between cost maps and network maps. Recall that handles dependencies between cost maps and network maps. Recall that
cost maps present the costs between PIDs, and PID names depend on a cost maps present the costs between PIDs, and PID names depend on a
skipping to change at page 7, line 18 skipping to change at page 7, line 35
According to [RFC7285], a legacy ALTO server with two network maps, According to [RFC7285], a legacy ALTO server with two network maps,
with resource IDs "net1" and "net2", could offer a single Endpoint with resource IDs "net1" and "net2", could offer a single Endpoint
Property Service for the two properties "net1.pid" and "net2.pid". Property Service for the two properties "net1.pid" and "net2.pid".
An ALTO server which supports the extensions defined in this An ALTO server which supports the extensions defined in this
document, would, instead, offer two different Property Maps for the document, would, instead, offer two different Property Maps for the
"pid" property, one depending on "net1", the other on "net2". "pid" property, one depending on "net1", the other on "net2".
3. Entity Domains 3. Entity Domains
This document defines the following entity domains. For the This document defines the following entity domains. For the
definition of each domain, it includes the following template: domain definition of each entity domain, it includes the following template:
name, domain-specific addresses, and hierarchy and inheritance domain name, domain-specific addresses, and hierarchy and inheritance
semantics. semantics.
3.1. Internet Address Domains 3.1. Internet Address Domains
The document defines two domains (IPv4 and IPv6) for Internet The document defines two entity domains (IPv4 and IPv6) for Internet
addresses. Both domains include individual addresses and blocks of addresses. Both entity domains include individual addresses and
addresses. blocks of addresses.
3.1.1. IPv4 Domain 3.1.1. IPv4 Domain
3.1.1.1. Domain Name 3.1.1.1. Domain Name
ipv4 ipv4
3.1.1.2. Domain-Specific Entity Addresses 3.1.1.2. Domain-Specific Entity Addresses
Individual addresses are strings as specified by the IPv4Addresses Individual addresses are strings as specified by the IPv4Addresses
skipping to change at page 8, line 17 skipping to change at page 8, line 33
Individual addresses are strings as specified by Section 4 of Individual addresses are strings as specified by Section 4 of
[RFC5952]. Blocks of addresses are prefix-match strings as specified [RFC5952]. Blocks of addresses are prefix-match strings as specified
in Section 7 of [RFC5952]. For the purpose of defining properties, in Section 7 of [RFC5952]. For the purpose of defining properties,
an individual Internet address and the corresponding 128-bit prefix an individual Internet address and the corresponding 128-bit prefix
are considered aliases for the same entity. That is, are considered aliases for the same entity. That is,
"ipv6:2001:db8::1" and "ipv6:2001:db8::1/128" are equivalent, and "ipv6:2001:db8::1" and "ipv6:2001:db8::1/128" are equivalent, and
have the same set of properties. have the same set of properties.
3.1.3. Hierarchy and Inheritance of ipv4/ipv6 Domains 3.1.3. Hierarchy and Inheritance of ipv4/ipv6 Domains
Both domains allow property values to be inherited. Specifically, if Both entity domains allow property values to be inherited.
a property P is not defined for a specific Internet address I, but P Specifically, if a property P is not defined for a specific Internet
is defined for some block C which prefix-matches I, then the address address I, but P is defined for some block C which prefix-matches I,
I inherits the value of P defined for block C. If more than one such then the address I inherits the value of P defined for block C. If
block defines a value for P, I inherits the value of P in the block more than one such block defines a value for P, I inherits the value
with the longest prefix. It is important to notice that this longest of P in the block with the longest prefix. It is important to notice
prefix rule will ensure no multiple inheritance, and hence no that this longest prefix rule will ensure no multiple inheritance,
ambiguity. and hence no ambiguity.
Address blocks can also inherit properties: if property P is not Address blocks can also inherit properties: if property P is not
defined for a block C, but is defined for some block C' which prefix- defined for a block C, but is defined for some block C' which prefix-
matches C, and C' has a shorter mask than C, then block C inherits matches C, and C' has a shorter mask than C, then block C inherits
the property from C'. If there are several such blocks C', C the property from C'. If there are several such blocks C', C
inherits from the block with the longest prefix. inherits from the block with the longest prefix.
As an example, suppose that a server defines the property P for the As an example, suppose that a server defines the property P for the
following entities: following entities:
skipping to change at page 9, line 33 skipping to change at page 9, line 42
o If that entity would inherit a value for that property, then the o If that entity would inherit a value for that property, then the
ALTO server MUST return a "null" value for that property. In this ALTO server MUST return a "null" value for that property. In this
case, the ALTO client MUST recognize a "null" value as "no value" case, the ALTO client MUST recognize a "null" value as "no value"
and "do not apply the inheritance rules for this property." and "do not apply the inheritance rules for this property."
o If the entity would not inherit a value, then the ALTO server MAY o If the entity would not inherit a value, then the ALTO server MAY
return "null" or just omit the property. In this case, the ALTO return "null" or just omit the property. In this case, the ALTO
client cannot infer the value for this property of this entity client cannot infer the value for this property of this entity
from the Inheritance rules. So the client MUST interpret this from the Inheritance rules. So the client MUST interpret this
property has "no value". property has no value.
If the ALTO Server does not define any properties for an entity, then If the ALTO Server does not define any properties for an entity, then
the server MAY omit that entity from the response. the server MAY omit that entity from the response.
3.1.4. Relationship to Network Maps 3.1.4. Relationship to Network Maps
An Internet address domain MAY be associated with an ALTO network map An Internet address domain MAY be associated with an ALTO network map
resource. Logically, there is a map of Internet address entities to resource. Logically, there is a map of Internet address entities to
property values for each network map defined by the ALTO server, plus property values for each network map defined by the ALTO server, plus
an additional property map for Internet address entities which are an additional property map for Internet address entities which are
skipping to change at page 10, line 8 skipping to change at page 10, line 16
property values. These maps are separate from each other. The property values. These maps are separate from each other. The
prefixes in the property map do not have to correspond to the prefixes in the property map do not have to correspond to the
prefixes defining the network map's PIDs. For example, the property prefixes defining the network map's PIDs. For example, the property
map for a network map MAY assign properties to "ipv4:192.0.2.0/24" map for a network map MAY assign properties to "ipv4:192.0.2.0/24"
even if that prefix is not associated with any PID in the network even if that prefix is not associated with any PID in the network
map. map.
3.2. PID Domain 3.2. PID Domain
The PID domain associates property values with the PIDs in a network The PID domain associates property values with the PIDs in a network
map. Accordingly, this domain always depends on a network map. map. Accordingly, this entity domain always depends on a network
map.
3.2.1. Domain Name 3.2.1. Domain Name
pid pid
3.2.2. Domain-Specific Entity Addresses 3.2.2. Domain-Specific Entity Addresses
The entity addresses are the PID names of the associated network map. The entity addresses are the PID names of the associated network map.
3.2.3. Hierarchy and Inheritance 3.2.3. Hierarchy and Inheritance
skipping to change at page 10, line 40 skipping to change at page 10, line 49
For example, suppose "PID1" consists of the prefix For example, suppose "PID1" consists of the prefix
"ipv4:192.0.2.0/24", and has the property "P" with value "v1". The "ipv4:192.0.2.0/24", and has the property "P" with value "v1". The
Internet address entities "ipv4:192.0.2.0" and "ipv4:192.0.2.0/24", Internet address entities "ipv4:192.0.2.0" and "ipv4:192.0.2.0/24",
in the IPv4 domain MAY have a value for the property "P", and if they in the IPv4 domain MAY have a value for the property "P", and if they
do, it is not necessarily "v1". do, it is not necessarily "v1".
3.3. Internet Address Properties vs. PID Properties 3.3. Internet Address Properties vs. PID Properties
Because the Internet address and PID domains are completely separate, Because the Internet address and PID domains are completely separate,
the question may arise as to which domain is best for a property. In the question may arise as to which entity domain is the best for a
general, the Internet address domain is RECOMMENDED for properties property. In general, the Internet address domain is RECOMMENDED for
that are closely related to the Internet address, or are associated properties that are closely related to the Internet address, or are
with, and inherited through, blocks of addresses. associated with, and inherited through, blocks of addresses.
The PID domain is RECOMMENDED for properties that arise from the The PID domain is RECOMMENDED for properties that arise from the
definition of the PID, rather than from the Internet address prefixes definition of the PID, rather than from the Internet address prefixes
in that PID. in that PID.
For example, because Internet addresses are allocated to service For example, because Internet addresses are allocated to service
providers by blocks of prefixes, an "ISP" property would be best providers by blocks of prefixes, an "ISP" property would be best
associated with the Internet address domain. On the other hand, a associated with the Internet address domain. On the other hand, a
property that explains why a PID was formed, or how it relates a property that explains why a PID was formed, or how it relates a
provider's network, would best be associated with the PID domain. provider's network, would best be associated with the PID domain.
skipping to change at page 11, line 34 skipping to change at page 11, line 44
4.3. Accept Input Parameters 4.3. Accept Input Parameters
None. None.
4.4. Capabilities 4.4. Capabilities
The capabilities are defined by an object of type The capabilities are defined by an object of type
PropertyMapCapabilities: PropertyMapCapabilities:
object { object {
DomainName domain-types<1..*>; DomainName entity-domain-types<1..*>;
PropertyName prop-types<1..*>; PropertyName prop-types<1..*>;
} PropertyMapCapabilities; } PropertyMapCapabilities;
where "domain-types" is an array with the domains of the entities in where "entity-domain-types" is an array with the domains of the
this property map, and "prop-types" is an array with the names of the entities in this property map, and "prop-types" is an array with the
properties returned for entities in those domains. names of the properties returned for entities in those domains.
4.5. Uses 4.5. Uses
An array with the resource ID(s) of resource(s) with which the An array with the resource ID(s) of resource(s) with which the entity
domains in this map are associated. In most cases, this array will domains in this map are associated. In most cases, this array will
have at most one ID, for example, for a network map resource. have at most one ID, for example, for a network map resource.
However, the "uses" field MUST NOT contain two resources of the same However, the "uses" field MUST NOT contain two resources of the same
resource type. For example, if a property map depends on network map resource type. For example, if a property map depends on network map
resource, the "uses" field MUST include exactly one network map resource, the "uses" field MUST include exactly one network map
resource. resource.
4.6. Response 4.6. Response
If the domains in this property map depend on other resources, the If the entity domains in this property map depend on other resources,
"dependent-vtags" field in the "meta" field of the response MUST be the "dependent-vtags" field in the "meta" field of the response MUST
an array that includes the version tags of those resources. The data be an array that includes the version tags of those resources. The
component of a Property Map response is named "property-map", which data component of a Property Map response is named "property-map",
is a JSON object of type PropertyMapData, where: which is a JSON object of type PropertyMapData, where:
object { object {
PropertyMapData property-map; PropertyMapData property-map;
} InfoResourceProperties : ResponseEntityBase; } InfoResourceProperties : ResponseEntityBase;
object-map { object-map {
EntityAddr -> EntityProps; EntityAddr -> EntityProps;
} PropertyMapData; } PropertyMapData;
object { object {
skipping to change at page 12, line 41 skipping to change at page 12, line 51
strings of type PropertyName. A protocol implementation SHOULD strings of type PropertyName. A protocol implementation SHOULD
assume that the property value is either a JSONString or a JSON assume that the property value is either a JSONString or a JSON
"null" value, and fail to parse if it is not, unless the "null" value, and fail to parse if it is not, unless the
implementation is using an extension to this document that indicates implementation is using an extension to this document that indicates
when and how property values of other data types are signaled. when and how property values of other data types are signaled.
For each entity in the Property Map, the ALTO Server returns the For each entity in the Property Map, the ALTO Server returns the
value defined for each of the properties specified in this resource's value defined for each of the properties specified in this resource's
"capabilities" list. For efficiency, the ALTO Server SHOULD omit "capabilities" list. For efficiency, the ALTO Server SHOULD omit
property values that are inherited rather than explicitly defined; if property values that are inherited rather than explicitly defined; if
a client needs inherited values, the client SHOULD use the domain's a client needs inherited values, the client SHOULD use the entity
inheritance rules to deduce those values. domain's inheritance rules to deduce those values.
5. Filtered Property Map Resource 5. Filtered Property Map Resource
A Filtered Property Map returns the values of a set of properties for A Filtered Property Map returns the values of a set of properties for
a set of entities selected by the client. a set of entities selected by the client.
Section 7.5, Section 7.6 and Section 7.7 give examples of filtered Section 7.5, Section 7.6 and Section 7.7 give examples of filtered
property map requests and responses. property map requests and responses.
5.1. Media Type 5.1. Media Type
skipping to change at page 13, line 33 skipping to change at page 13, line 41
object { object {
EntityAddr entities<1..*>; EntityAddr entities<1..*>;
PropertyName properties<1..*>; PropertyName properties<1..*>;
} ReqFilteredPropertyMap; } ReqFilteredPropertyMap;
with fields: with fields:
entities: List of entity addresses for which the specified entities: List of entity addresses for which the specified
properties are to be returned. The ALTO server MUST interpret properties are to be returned. The ALTO server MUST interpret
entries appearing multiple times as if they appeared only once. entries appearing multiple times as if they appeared only once.
The domain of each entity MUST be included in the list of domains The domain of each entity MUST be included in the list of entity
in this resource's "capabilities" field (see Section 5.4). domains in this resource's "capabilities" field (see Section 5.4).
properties: List of properties to be returned for each entity. Each properties: List of properties to be returned for each entity. Each
specified property MUST be included in the list of properties in specified property MUST be included in the list of properties in
this resource's "capabilities" field (see Section 5.4). The ALTO this resource's "capabilities" field (see Section 5.4). The ALTO
server MUST interpret entries appearing multiple times as if they server MUST interpret entries appearing multiple times as if they
appeared only once. appeared only once.
Note that the "entities" and "properties" fields MUST have at Note that the "entities" and "properties" fields MUST have at
least one entry each. least one entry each.
5.4. Capabilities 5.4. Capabilities
The capabilities are defined by an object of type The capabilities are defined by an object of type
PropertyMapCapabilities, as defined in Section 4.4. PropertyMapCapabilities, as defined in Section 4.4.
5.5. Uses 5.5. Uses
An array with the resource ID(s) of resource(s) with which the An array with the resource ID(s) of resource(s) with which the entity
domains in this map are associated. In most cases, this array will domains in this map are associated. In most cases, this array will
have at most one ID, and it will be for a network map resource. have at most one ID, and it will be for a network map resource.
5.6. Response 5.6. Response
The response is the same as for the property map (see Section 4.6), The response is the same as for the property map (see Section 4.6),
except that it only includes the entities and properties requested by except that it only includes the entities and properties requested by
the client. the client.
Also, the Filtered Property Map response MUST include all inherited Also, the Filtered Property Map response MUST include all inherited
property values for the specified entities (unlike the Full Property property values for the specified entities (unlike the Full Property
Map, the Filtered Property Map response does not include enough Map, the Filtered Property Map response does not include enough
information for the client to calculate the inherited values). information for the client to calculate the inherited values).
If an entity in "entities" in the request is invalid, the ALTO server
MUST return an "E_INVALID_FIELD_VALUE" error defined in Section 8.5.2
of [RFC7285]. An entity can be invalid if the domain of the entity
is not defined in the IRD for this service or the entity address is
an invalid address of the entity domain. On the other hand, a valid
entity address is not an error, even if the server does not define a
value for a requested property. In this case, the server MUST omit
that property from the response for only that entity. If a request
contains a property in "properties" and the property is not specified
in the IRD for the service, the ALTO server MUST return an
"E_INVALID_FIELD_VALUE" error defined in Section 8.5.2 of [RFC7285].
The "value" of the error message SHOULD indicate the wrong property.
If the ALTO server does not define a requested property's value for a If the ALTO server does not define a requested property's value for a
particular entity, then it MUST omit that property from the response particular entity, then it MUST omit that property from the response
for only that endpoint. for only that endpoint.
If the ALTO server does not support a requested entity's domain, then If the ALTO server does not support a requested entity's domain, then
it MUST return an E_INVALID_FIELD_VALUE error defined in it MUST return an E_INVALID_FIELD_VALUE error defined in
Section 8.5.2 of [RFC7285]. Section 8.5.2 of [RFC7285].
6. Impact on Legacy ALTO Servers and ALTO Clients 6. Impact on Legacy ALTO Servers and ALTO Clients
6.1. Impact on Endpoint Property Service 6.1. Impact on Endpoint Property Service
The Property Maps defined in this document provide the same The Property Maps defined in this document provide the same
functionality as the Endpoint Property Service (EPS) defined in functionality as the Endpoint Property Service (EPS) defined in
Section 11.4 of [RFC7285]. Accordingly, it is RECOMMENDED that the Section 11.4 of [RFC7285]. Accordingly, it is RECOMMENDED that the
EPS be deprecated in favor of Property Maps. However, ALTO servers EPS be deprecated in favor of Property Maps. However, ALTO servers
MAY provide an EPS for the benefit of legacy clients. MAY provide an EPS for the benefit of legacy clients.
6.2. Impact on Resource-Specific Properties 6.2. Impact on Resource-Specific Properties
skipping to change at page 15, line 5 skipping to change at page 15, line 26
property names are prefixed with the ID of the resource they depend property names are prefixed with the ID of the resource they depend
upon, while global property names have no such prefix. The property upon, while global property names have no such prefix. The property
map resources defined in this document do not distinguish between map resources defined in this document do not distinguish between
those two types of properties. Instead, if there is a dependency, it those two types of properties. Instead, if there is a dependency, it
is indicated by the "uses" capability of a property map, and is is indicated by the "uses" capability of a property map, and is
shared by all properties and entity domains in that map. shared by all properties and entity domains in that map.
Accordingly, it is RECOMMENDED that resource-specific endpoint Accordingly, it is RECOMMENDED that resource-specific endpoint
properties be deprecated, and no new resource-specific endpoint properties be deprecated, and no new resource-specific endpoint
properties be defined. properties be defined.
6.3. Impact on the "pid" Property 6.3. Impact on the pid Property
Section 7.1.1 of [RFC7285] defines the resource-specific endpoint Section 7.1.1 of [RFC7285] defines the resource-specific endpoint
property "pid", whose value is the name of the PID containing that property name "pid", whose value is the name of the PID containing
endpoint. For compatibility with legacy clients, an ALTO server that endpoint. For compatibility with legacy clients, an ALTO server
which provides the "pid" property via the Endpoint Property Service which provides the "pid" property via the Endpoint Property Service
MUST use that definition, and that syntax, in the EPS resource. MUST use that definition, and that syntax, in the EPS resource.
However, when used with Property Maps, this document amends the However, when used with Property Maps, this document amends the
definition of the "pid" property as follows. definition of the "pid" property as follows.
First, the name of the property is simply "pid"; the name is not First, the name of the property is simply "pid"; the name is not
prefixed with the resource ID of a network map. The "uses" prefixed with the resource ID of a network map. The "uses"
capability of the property map resource indicates the associated capability of the property map resource indicates the associated
network map. This implies that a property map can only return the network map. This implies that a property map can only return the
skipping to change at page 17, line 11 skipping to change at page 17, line 33
"resources" : { "resources" : {
"default-network-map" : { "default-network-map" : {
"uri" : "http://alto.example.com/networkmap", "uri" : "http://alto.example.com/networkmap",
"media-type" : "application/alto-networkmap+json" "media-type" : "application/alto-networkmap+json"
}, },
.... property map resources .... .... property map resources ....
"country-state-property-map" : { "country-state-property-map" : {
"uri" : "http://alto.example.com/propmap/full/inet-cs", "uri" : "http://alto.example.com/propmap/full/inet-cs",
"media-type" : "application/alto-propmap+json", "media-type" : "application/alto-propmap+json",
"capabilities" : { "capabilities" : {
"domain-types": [ "ipv4", "ipv6" ], "entity-domain-types": [ "ipv4", "ipv6" ],
"prop-types" : [ "country", "state" ] "prop-types" : [ "country", "state" ]
} }
}, },
"isp-asn-property-map" : { "isp-asn-property-map" : {
"uri" : "http://alto.example.com/propmap/full/inet-ia", "uri" : "http://alto.example.com/propmap/full/inet-ia",
"media-type" : "application/alto-propmap+json", "media-type" : "application/alto-propmap+json",
"capabilities" : { "capabilities" : {
"domain-types": [ "ipv4", "ipv6" ], "entity-domain-types": [ "ipv4", "ipv6" ],
"prop-types" : [ "ISP", "ASN" ] "prop-types" : [ "ISP", "ASN" ]
} }
}, },
"iacs-property-map" : { "iacs-property-map" : {
"uri" : "http://alto.example.com/propmap/lookup/inet-iacs", "uri" : "http://alto.example.com/propmap/lookup/inet-iacs",
"media-type" : "application/alto-propmap+json", "media-type" : "application/alto-propmap+json",
"accepts" : "application/alto-propmapparams+json", "accepts" : "application/alto-propmapparams+json",
"capabilities" : { "capabilities" : {
"domain-types": [ "ipv4", "ipv6" ], "entity-domain-types": [ "ipv4", "ipv6" ],
"prop-types" : [ "ISP", "ASN", "country", "state" ] "prop-types" : [ "ISP", "ASN", "country", "state" ]
} }
}, },
"pid-property-map" : { "pid-property-map" : {
"uri" : "http://alto.example.com/propmap/lookup/pid", "uri" : "http://alto.example.com/propmap/lookup/pid",
"media-type" : "application/alto-propmap+json", "media-type" : "application/alto-propmap+json",
"accepts" : "application/alto-propmapparams+json", "accepts" : "application/alto-propmapparams+json",
"uses" : [ "default-network-map" ] "uses" : [ "default-network-map" ]
"capabilities" : { "capabilities" : {
"domain-types" : [ "ipv4", "ipv6" ], "entity-domain-types" : [ "ipv4", "ipv6" ],
"prop-types" : [ "pid" ] "prop-types" : [ "pid" ]
} }
}, },
"availbw-property-map" : { "location-property-map": {
"uri" : "http://alto.example.com/propmap/lookup/availbw", "uri": "http://alto.exmaple.com/propmap/location",
"media-type" : "application/alto-propmap+json", "media-type": "application/alto-propmap+json",
"accepts" : "application/alto-propmapparams+json", "accepts": "application/alto-propmapparams+json",
"capabilities" : { "uses" : [ "default-network-map" ],
"domain-types" : [ "ane" ], "capabilities": {
"prop-types" : [ "availbw", "delay" ] "domain-types": [ "pid" ],
} "prop-types": [ "country", "state" ]
}
}, },
"legacy-pid-property-map" : { "legacy-pid-property" : {
"uri" : "http://alto.example.com/legacy/eps-pid", "uri" : "http://alto.example.com/legacy/eps-pid",
"media-type" : "application/alto-endpointprop+json", "media-type" : "application/alto-endpointprop+json",
"accepts" : "application/alto-endpointpropparams+json", "accepts" : "application/alto-endpointpropparams+json",
"capabilities" : { "capabilities" : {
"prop-types" : [ "default-network-map.pid" ] "prop-types" : [ "default-network-map.pid" ]
} }
} }
} }
Figure 5: Example IRD Figure 5: Example IRD
skipping to change at page 21, line 46 skipping to change at page 22, line 46
"ipv4:192.0.2.64": {"pid": "pid1"}, "ipv4:192.0.2.64": {"pid": "pid1"},
"ipv4:192.0.2.128": {"pid": "defaultpid"}, "ipv4:192.0.2.128": {"pid": "defaultpid"},
"ipv4:192.0.2.0/26": {"pid": "pid1"}, "ipv4:192.0.2.0/26": {"pid": "pid1"},
"ipv4:192.0.2.0/30": {"pid": "pid2"} "ipv4:192.0.2.0/30": {"pid": "pid2"}
} }
} }
7.8. Filtered Property Map Example #4 7.8. Filtered Property Map Example #4
The following example uses the Filtered Property Map resource to The following example uses the Filtered Property Map resource to
request the "availbw" property for several abstract network elements. request the "country" and "state" property for several PIDs defined
in "default-network-map".
POST /propmap/lookup/availbw HTTP/1.1 POST /propmap/lookup/location HTTP/1.1
Host: alto.example.com Host: alto.example.com
Accept: application/alto-propmap+json,application/alto-error+json Accept: application/alto-propmap+json,application/alto-error+json
Content-Length: ### Content-Length: ###
Content-Type: application/alto-propmapparams+json Content-Type: application/alto-propmapparams+json
{ {
"entities" : [ "entities" : ["pid:pid3",
"ane:L001", "pid:pid4",
"ane:Lae0", "pid:pid5",
"ane:L3eb ], "pid:pid6",
"properties" : [ "availbw" ] "pid:pid7"],
"properties" : [ "country", "state" ]
} }
HTTP/1.1 200 OK HTTP/1.1 200 OK
Content-Length: ### Content-Length: ###
Content-Type: application/alto-propmap+json Content-Type: application/alto-propmap+json
{ {
"meta" : {
"dependent-vtags" : [
{"resource-id": "default-network-map",
"tag": "7915dc0290c2705481c491a2b4ffbec482b3cf62"}
]
},
"property-map": { "property-map": {
"ane:L001": {"availbw": "55"}, "pid:pid3": {
"ane:Lae0": {"availbw": "70"}, "country": "us",
"ane:L3eb": {"availbw": "40"} "state": "CA"
},
"pid:pid4": {
"country": "us",
"state": "CT"
},
"pid:pid5": {
"country": "ca",
"state": "QC"
},
"pid:pid6": {
"country": "ca",
"state": "NT"
},
"pid:pid7": {
"country": "fr"
}
} }
} }
8. Security Considerations 8. Security Considerations
As discussed in Section 15 of [RFC7285], properties MAY have As discussed in Section 15 of [RFC7285], properties MAY have
sensitive customer-specific information. If this is the case, an sensitive customer-specific information. If this is the case, an
ALTO Server MAY limit access to those properties by providing several ALTO Server MAY limit access to those properties by providing several
different Property Maps. For non-sensitive properties, the ALTO different Property Maps. For non-sensitive properties, the ALTO
Server would provide a URI which accepts requests from any client. Server would provide a URI which accepts requests from any client.
skipping to change at page 23, line 51 skipping to change at page 25, line 19
Interoperability considerations: This document specifies formats of Interoperability considerations: This document specifies formats of
conforming messages and the interpretation thereof. conforming messages and the interpretation thereof.
Published specification: This document is the specification for Published specification: This document is the specification for
these media types; see Table 1 for the section documenting each these media types; see Table 1 for the section documenting each
media type. media type.
Applications that use this media type: ALTO servers and ALTO clients Applications that use this media type: ALTO servers and ALTO clients
either stand alone or are embedded within other applications. either stand alone or are embedded within other applications.
Additional information: ~ Magic number(s): ~ n/a File extension(s): ~ Additional information:
This document uses the mime type to refer to protocol messages and
thus does not require a file extension. Macintosh file type code(s): Magic number(s): n/a
~ n/a
File extension(s): This document uses the mime type to refer to
protocol messages and thus does not require a file extension.
Macintosh file type code(s): n/a
Person & email address to contact for further information: See Person & email address to contact for further information: See
Authors' Addresses section. Authors' Addresses section.
Intended usage: COMMON Intended usage: COMMON
Restrictions on usage: n/a Restrictions on usage: n/a
Author: See Authors' Addresses section. Author: See Authors' Addresses section.
skipping to change at page 24, line 32 skipping to change at page 26, line 13
Domain Registry", listed in Table 2. Domain Registry", listed in Table 2.
+-------------+--------------------------+--------------------------+ +-------------+--------------------------+--------------------------+
| Identifier | Entity Address Encoding | Hierarchy & Inheritance | | Identifier | Entity Address Encoding | Hierarchy & Inheritance |
+-------------+--------------------------+--------------------------+ +-------------+--------------------------+--------------------------+
| ipv4 | See Section 3.1.1 | See Section 3.1.3 | | ipv4 | See Section 3.1.1 | See Section 3.1.3 |
| ipv6 | See Section 3.1.2 | See Section 3.1.3 | | ipv6 | See Section 3.1.2 | See Section 3.1.3 |
| pid | See Section 3.2 | None | | pid | See Section 3.2 | None |
+-------------+--------------------------+--------------------------+ +-------------+--------------------------+--------------------------+
Table 2: ALTO Entity Domain Names. Table 2: ALTO Entity Domains.
This registry serves two purposes. First, it ensures uniqueness of This registry serves two purposes. First, it ensures uniqueness of
identifiers referring to ALTO entity domains. Second, it states the identifiers referring to ALTO entity domains. Second, it states the
requirements for allocated domain names. requirements for allocated entity domains.
This registry is considered as an extension of the "ALTO Address Type 9.2.1. Consistency Procedure between ALTO Address Type Registry and
Registry" defined in Section 14.4 of [RFC7285]. In particularly, ALTO Entity Domain Registry
o An entity MAY or MAY NOT be an endpoint. For example, "pid" is One potential issue of introducing the "ALTO Entity Domain Registry"
registered as an entity domain in Table 2, but it is not an is its relationship with the "ALTO Address Types Registry" already
endpoint address type. defined in Section 14.4 of [RFC7285]. In particular, the entity
address of an entity domain registered in the "ALTO Entity Domain
Registry" MAY match an address type defined in "ALTO Address Type
Registry". It is necessary to precisely define and guarantee the
consistency between "ALTO Address Type Registry" and "ALTO Entity
Domain Registry".
o An endpoint MUST be an entity. For example, "ipv4" and "ipv6" are We define that the ALTO Entity Domain Registry is consistent with
already registered in "ALTO Address Type Registry" in [RFC7285], ALTO Address Type Registry if two conditions are satisfied:
so they MUST be registered as entity domains.
o When an address type is already or able to be registered in the
ALTO Address Type Registry [RFC7285], the same identifier MUST be
used when a corresponding entity domain is registered in the ALTO
Entity Domain Registry.
o If an ALTO entity domain has the same identifier as an ALTO
address type, their addresses encoding MUST be compatible.
To achieve this consistency, the following items MUST be checked
before registering a new ALTO entity domain in a future document:
o Whether the ALTO Address Type Registry contains an address type
that can be used as an entity address for the candidate domain
identifier. This has been done for the identifiers "ipv4" and
"ipv6" in Table 2.
o Whether the candidate entity address of the entity domain is able
to be an endpoint address, as defined in Sections 2.1 and 2.2 of
[RFC7285].
When a new ALTO entity domain is registered, the consistency with the
ALTO Address Type Registry MUST be ensured by the following
procedure:
o test: Do corresponding entity addresses match a known "network"
address type?
* if yes: (e.g., cell, MAC or socket addresses)
+ test: Is such an address type present in the ALTO Address
Type Registry?
- if yes: Set the new ALTO entity domain identifier to be
the found ALTO address type identifier.
- if no: Define a new ALTO entity domain identifier and use
it to register a new address type in the ALTO Address
Type Registry following Section 14.4 of [RFC7285].
+ Use the new ALTO entity domain identifier to register a new
ALTO entity domain in the ALTO Entity Domain Registry
following Section 9.2.2 of this document.
* if no (e.g., pid name, ane name or country code): Proceed with
the ALTO Entity Domain registration as described in
Section 9.2.2.
9.2.2. ALTO Entity Domain Registration Process
New ALTO entity domains are assigned after IETF Review [RFC5226] to New ALTO entity domains are assigned after IETF Review [RFC5226] to
ensure that proper documentation regarding the new ALTO entity ensure that proper documentation regarding the new ALTO entity
domains and their security considerations has been provided. RFCs domains and their security considerations has been provided. RFCs
defining new entity domains SHOULD indicate how an entity in a defining new entity domains SHOULD indicate how an entity in a
registered domain is encoded as an EntityName, and, if applicable, registered domain is encoded as an EntityAddr, and, if applicable,
the rules defining the entity hierarchy and property inheritance. the rules defining the entity hierarchy and property inheritance.
Updates and deletions of ALTO entity domains follow the same Updates and deletions of ALTO entity domains follow the same
procedure. procedure.
Registered ALTO entity domain identifiers MUST conform to the Registered ALTO entity domain identifiers MUST conform to the
syntactical requirements specified in Section 2.3. Identifiers are syntactical requirements specified in Section 2.3. Identifiers are
to be recorded and displayed as strings. to be recorded and displayed as strings.
When a new address type is registered in the ALTO Address Type Requests to the IANA to add a new value to the registry MUST include
Registry [RFC7285], the same identifier MUST be also registered in the following information:
the ALTO Entity Domain Registry. And the Entity Address Encoding of
this entity domain identifier MUST include both Address Encoding and
Prefix Encoding of the same identifier registered in the ALTO Address
Type Registry [RFC7285]. For the purpose of defining properties, an
individual entity address and the corresponding full-length prefix
MUST be considered aliases for the same entity.
Requests to add a new value to the registry MUST include the
following information:
o Identifier: The name of the desired ALTO entity domain. o Identifier: The name of the desired ALTO entity domain.
o Entity Address Encoding: The procedure for encoding the address of o Entity Address Encoding: The procedure for encoding the address of
an entity of the registered type as an EntityAddr (see an entity of the registered type as an EntityAddr (see
Section 2.4). Section 2.4). If corresponding entity addresses of an entity
domain match a known "network" address type, the Entity Address
Encoding of this domain identifier MUST include both Address
Encoding and Prefix Encoding of the same identifier registered in
the ALTO Address Type Registry [RFC7285]. For the purpose of
defining properties, an individual entity address and the
corresponding full-length prefix MUST be considered aliases for
the same entity.
o Hierarchy: If the entities form a hierarchy, the procedure for o Hierarchy: If the entities form a hierarchy, the procedure for
determining that hierarchy. determining that hierarchy.
o Inheritance: If entities can inherit property values from other o Inheritance: If entities can inherit property values from other
entities, the procedure for determining that inheritance. entities, the procedure for determining that inheritance.
o Security Considerations: In some usage scenarios, entity addresses o Security Considerations: In some usage scenarios, entity addresses
carried in ALTO Protocol messages MAY reveal information about an carried in ALTO Protocol messages MAY reveal information about an
ALTO client or an ALTO service provider. Applications and ALTO ALTO client or an ALTO service provider. Applications and ALTO
skipping to change at page 26, line 12 skipping to change at page 28, line 39
This specification requests registration of the identifiers "ipv4", This specification requests registration of the identifiers "ipv4",
"ipv6" and "pid", as shown in Table 2. "ipv6" and "pid", as shown in Table 2.
9.3. ALTO Endpoint Property Type Registry 9.3. ALTO Endpoint Property Type Registry
The ALTO Endpoint Property Type Registry was created by [RFC7285]. The ALTO Endpoint Property Type Registry was created by [RFC7285].
If possible, the name of that registry SHOULD be changed to "ALTO If possible, the name of that registry SHOULD be changed to "ALTO
Entity Property Type Registry", to indicate that it is not restricted Entity Property Type Registry", to indicate that it is not restricted
to Endpoint Properties. If it is not feasible to change the name, to Endpoint Properties. If it is not feasible to change the name,
the description MUST be amended to indicate that it registers the description MUST be amended to indicate that it registers
properties in all domains, rather than just the Internet address properties in all entity domains, rather than just the Internet
domain. address domain.
10. References 10. References
10.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, <https://www.rfc- DOI 10.17487/RFC2119, March 1997,
editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005, RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>. <https://www.rfc-editor.org/info/rfc3986>.
[RFC4632] Fuller, V. and T. Li, "Classless Inter-domain Routing [RFC4632] Fuller, V. and T. Li, "Classless Inter-domain Routing
(CIDR): The Internet Address Assignment and Aggregation (CIDR): The Internet Address Assignment and Aggregation
Plan", BCP 122, RFC 4632, DOI 10.17487/RFC4632, August Plan", BCP 122, RFC 4632, DOI 10.17487/RFC4632, August
2006, <https://www.rfc-editor.org/info/rfc4632>. 2006, <https://www.rfc-editor.org/info/rfc4632>.
[RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", RFC 5226, IANA Considerations Section in RFCs", RFC 5226,
DOI 10.17487/RFC5226, May 2008, <https://www.rfc- DOI 10.17487/RFC5226, May 2008,
editor.org/info/rfc5226>. <https://www.rfc-editor.org/info/rfc5226>.
[RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6 [RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6
Address Text Representation", RFC 5952, Address Text Representation", RFC 5952,
DOI 10.17487/RFC5952, August 2010, <https://www.rfc- DOI 10.17487/RFC5952, August 2010,
editor.org/info/rfc5952>. <https://www.rfc-editor.org/info/rfc5952>.
[RFC7159] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data [RFC7159] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data
Interchange Format", RFC 7159, DOI 10.17487/RFC7159, March Interchange Format", RFC 7159, DOI 10.17487/RFC7159, March
2014, <https://www.rfc-editor.org/info/rfc7159>. 2014, <https://www.rfc-editor.org/info/rfc7159>.
[RFC7285] Alimi, R., Ed., Penno, R., Ed., Yang, Y., Ed., Kiesel, S., [RFC7285] Alimi, R., Ed., Penno, R., Ed., Yang, Y., Ed., Kiesel, S.,
Previdi, S., Roome, W., Shalunov, S., and R. Woundy, Previdi, S., Roome, W., Shalunov, S., and R. Woundy,
"Application-Layer Traffic Optimization (ALTO) Protocol", "Application-Layer Traffic Optimization (ALTO) Protocol",
RFC 7285, DOI 10.17487/RFC7285, September 2014, RFC 7285, DOI 10.17487/RFC7285, September 2014,
<https://www.rfc-editor.org/info/rfc7285>. <https://www.rfc-editor.org/info/rfc7285>.
10.2. Informative References
[I-D.ietf-alto-path-vector]
Bernstein, G., Chen, S., Gao, K., Lee, Y., Roome, W.,
Scharf, M., Yang, Y., and J. Zhang, "ALTO Extension: Path
Vector Cost Type", draft-ietf-alto-path-vector-03 (work in
progress), March 2018.
Authors' Addresses Authors' Addresses
Wendy Roome Wendy Roome
Nokia Bell Labs (Retired) Nokia Bell Labs (Retired)
124 Burlington Rd 124 Burlington Rd
Murray Hill, NJ 07974 Murray Hill, NJ 07974
USA USA
Phone: +1-908-464-6975 Phone: +1-908-464-6975
Email: wendy@wdroome.com Email: wendy@wdroome.com
 End of changes. 72 change blocks. 
175 lines changed or deleted 295 lines changed or added

This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/