Internet Engineering Task Force (IETF)                      M. Boucadair
Request for Comments: 7220                                France Telecom
Category: Standards Track                                       R. Penno
ISSN: 2070-1721                                                  D. Wing
                                                                   Cisco
                                                                May 2014
        
Internet Engineering Task Force (IETF)                      M. Boucadair
Request for Comments: 7220                                France Telecom
Category: Standards Track                                       R. Penno
ISSN: 2070-1721                                                  D. Wing
                                                                   Cisco
                                                                May 2014
        

Description Option for the Port Control Protocol (PCP)

端口控制协议(PCP)的描述选项

Abstract

摘要

This document extends the Port Control Protocol (PCP) with the ability to associate a description with a PCP-instantiated mapping. It does this by defining a new DESCRIPTION option.

本文档扩展了端口控制协议(PCP),使其能够将描述与PCP实例化映射相关联。它通过定义一个新的描述选项来实现这一点。

Status of This Memo

关于下段备忘

This is an Internet Standards Track document.

这是一份互联网标准跟踪文件。

This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 5741.

本文件是互联网工程任务组(IETF)的产品。它代表了IETF社区的共识。它已经接受了公众审查,并已被互联网工程指导小组(IESG)批准出版。有关互联网标准的更多信息,请参见RFC 5741第2节。

Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc7220.

有关本文件当前状态、任何勘误表以及如何提供反馈的信息,请访问http://www.rfc-editor.org/info/rfc7220.

Copyright Notice

版权公告

Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved.

版权所有(c)2014 IETF信托基金和确定为文件作者的人员。版权所有。

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.

本文件受BCP 78和IETF信托有关IETF文件的法律规定的约束(http://trustee.ietf.org/license-info)自本文件出版之日起生效。请仔细阅读这些文件,因为它们描述了您对本文件的权利和限制。从本文件中提取的代码组件必须包括信托法律条款第4.e节中所述的简化BSD许可证文本,并提供简化BSD许可证中所述的无担保。

Table of Contents

目录

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Format  . . . . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Behavior  . . . . . . . . . . . . . . . . . . . . . . . . . .   4
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   5
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   5
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   5
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   5
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   6
        
   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Format  . . . . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Behavior  . . . . . . . . . . . . . . . . . . . . . . . . . .   4
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   5
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   5
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   5
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   5
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   6
        
1. Introduction
1. 介绍

This document extends the base PCP [RFC6887] with the ability to associate a human-readable description with a PCP-instantiated mapping. It does this by defining a new DESCRIPTION option.

本文档扩展了基本PCP[RFC6887],使其能够将人类可读的描述与PCP实例化映射相关联。它通过定义一个新的描述选项来实现这一点。

This PCP option can be used in simple scenarios with a PCP client and PCP server, as well as in more complex scenarios where an interworking function is used to proxy between a UPnP IGD Control Point and a PCP server [RFC6970].

此PCP选项可用于PCP客户端和PCP服务器的简单场景,以及使用互通功能在UPnP IGD控制点和PCP服务器之间进行代理的更复杂场景[RFC6970]。

Querying the PCP server to get the description text of an existing mapping is out of scope.

查询PCP服务器以获取现有映射的描述文本超出范围。

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119].

本文件中的关键词“必须”、“不得”、“要求”、“应”、“不应”、“应”、“不应”、“建议”、“可”和“可选”应按照RFC 2119[RFC2119]中所述进行解释。

2. Format
2. 总体安排

The format of the DESCRIPTION option is shown in Figure 1.

描述选项的格式如图1所示。

       0                   1                   2                   3
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |Option Code=128|  Reserved     |           Length              |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                           Description                         |
      :                                                               :
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        
       0                   1                   2                   3
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |Option Code=128|  Reserved     |           Length              |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                           Description                         |
      :                                                               :
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
        

This Option:

此选项:

Option Name: DESCRIPTION Number: 128 Purpose: Used to associate a text description with a mapping Valid for Opcodes: MAP, PEER Length: Variable, maximum 1016 octets. May appear in: request. May appear in response only if it appeared in the associated request. Maximum occurrences: 1

选项名称:描述编号:128用途:用于将文本描述与操作码有效的映射关联:映射,对等长度:变量,最大1016个八位字节。可能出现在:请求。仅当它出现在相关请求中时,才可能出现在响应中。最多发生次数:1次

Figure 1: DESCRIPTION Option

图1:描述选项

The 'Reserved' field is initialized as specified in Section 7.3 of [RFC6887].

“保留”字段按照[RFC6887]第7.3节的规定进行初始化。

The Description field MUST carry UTF-8 encoded [RFC3629] description text. The description text MUST NOT be null terminated. The length of the description text is indicated by the Length field. In particular, the description text is not null terminated, and when a client or server receives a DESCRIPTION option, it MUST NOT rely on the presence of a NUL character in the wire format data to identify the end of the text.

描述字段必须包含UTF-8编码的[RFC3629]描述文本。说明文本不能以null结尾。描述文本的长度由长度字段指示。特别是,描述文本不是以null结尾的,当客户端或服务器接收到描述选项时,它不能依赖wire格式数据中是否存在NUL字符来标识文本的结尾。

This option can be used by a user (or an application) to indicate a description associated with a given mapping, such as "FTP server", "My remote access to my CP router", "Camera", "Network attached storage serve", etc.

用户(或应用程序)可以使用此选项来指示与给定映射相关联的描述,例如“FTP服务器”、“我对CP路由器的远程访问”、“摄像头”、“网络连接存储服务”等。

How the content of the DESCRIPTION option is used is deployment-specific. For example, the description text can be used by the entity managing the PCP server for many purposes, such as the following:

如何使用描述选项的内容取决于部署。例如,描述文本可由管理PCP服务器的实体用于多种目的,例如:

o The description text can be used as a hint when cleaning a mapping table by an administrator.

o 管理员在清理映射表时,可以使用说明文本作为提示。

o In some deployments making use of a portal to instruct PCP mappings (e.g., Section 5.2 of [PCP-DEPLOY]), the description text can be used to store a subscriber identifier.

o 在一些使用门户指示PCP映射的部署中(例如,[PCP-DEPLOY]第5.2节),描述文本可用于存储订户标识符。

3. Behavior
3. 行为

Support for the DESCRIPTION option by PCP servers and PCP clients is optional. This option (Code 128; see Figure 1) MAY be included in a PCP MAP/PEER request to associate a description with the requested mapping.

PCP服务器和PCP客户端对描述选项的支持是可选的。此选项(代码128;参见图1)可以包含在PCP映射/对等请求中,以将描述与请求的映射相关联。

A PCP server MAY ignore the DESCRIPTION option sent to it by a PCP client (e.g., if it does not support the option or if it is configured to ignore it). To signal that it has not accepted the option, a PCP server simply does not include the DESCRIPTION option in the response. If the PCP client does not receive a DESCRIPTION option in a response to a request enclosing a DESCRIPTION option, this means the PCP server does not support the option or it is configured to ignore it.

PCP服务器可能会忽略PCP客户端发送给它的描述选项(例如,如果它不支持该选项,或者如果它被配置为忽略该选项)。为了表示尚未接受该选项,PCP服务器只是在响应中不包含DESCRIPTION选项。如果PCP客户端在响应包含描述选项的请求时未接收到描述选项,这意味着PCP服务器不支持该选项或将其配置为忽略该选项。

If the DESCRIPTION option is not included in the PCP client request, the PCP server MUST NOT include the DESCRIPTION option in the associated response.

如果PCP客户端请求中未包含描述选项,则PCP服务器不得在相关响应中包含描述选项。

A PCP server SHOULD be able to store at least 128 bytes for a description. When the PCP server receives a DESCRIPTION option, it first stores the value of the received Description field, truncating it if it cannot store the entire value. The server MUST then send the stored value back to the PCP client in the DESCRIPTION option in the response.

PCP服务器应该能够存储至少128字节的描述。当PCP服务器接收到描述选项时,它首先存储接收到的描述字段的值,如果无法存储整个值,则将其截断。然后,服务器必须在响应中的“描述”选项中将存储的值发送回PCP客户端。

If the PCP client request contains invalid DESCRIPTION options (e.g., the content is not a legal UTF-8 string), the PCP server MUST ignore the request (i.e., MUST NOT return a DESCRIPTION option in the response).

如果PCP客户端请求包含无效的描述选项(例如,内容不是合法的UTF-8字符串),PCP服务器必须忽略该请求(即,响应中不得返回描述选项)。

To update the description text of a mapping maintained by a PCP server, the PCP client generates a PCP MAP/PEER renewal request that includes a DESCRIPTION option carrying the new description text. Upon receipt of the PCP request, the PCP server proceeds to the same

为了更新由PCP服务器维护的映射的描述文本,PCP客户端生成PCP映射/对等更新请求,该请求包括携带新描述文本的描述选项。收到PCP请求后,PCP服务器继续执行相同的操作

operations to validate a MAP/PEER request refreshing an existing mapping. If validation checks are successfully passed, the PCP server replaces the old description text with the new one included in the DESCRIPTION option, and the PCP server returns the updated description text in the response, truncated (if necessary) as described above.

用于验证映射/对等请求并刷新现有映射的操作。如果验证检查成功通过,则PCP服务器将使用描述选项中包含的新描述文本替换旧描述文本,并且PCP服务器将在响应中返回更新的描述文本,如上文所述进行截断(如有必要)。

The PCP client uses an empty DESCRIPTION option (i.e., Length set to 0) to erase the description text associated with a mapping. To indicate that the PCP server has successfully cleared the description text associated with a mapping, the PCP server returns the empty DESCRIPTION option in the response.

PCP客户端使用空描述选项(即,长度设置为0)擦除与映射关联的描述文本。要指示PCP服务器已成功清除与映射关联的描述文本,PCP服务器将在响应中返回空描述选项。

4. Security Considerations
4. 安全考虑

PCP-related security considerations are discussed in [RFC6887]. In addition, administrators of PCP servers SHOULD configure a maximum description length that does not lead to exhausting storage resources in the PCP server.

[RFC6887]中讨论了PCP相关的安全注意事项。此外,PCP服务器的管理员应配置最大描述长度,以避免耗尽PCP服务器中的存储资源。

If the PCP client and the PCP server are not under the same administrative entity, the DESCRIPTION option has the potential to leak privacy-related information. PCP clients should not use the DESCRIPTION option for such leakage. For example, the option should not be used to include user identifiers, locations, or names. Refer to Section 3.2 of [RFC6462] for a discussion on information leakage.

如果PCP客户端和PCP服务器不在同一管理实体下,说明选项可能会泄漏隐私相关信息。PCP客户端不应使用此类泄漏的描述选项。例如,该选项不应用于包括用户标识符、位置或名称。有关信息泄漏的讨论,请参阅[RFC6462]第3.2节。

5. IANA Considerations
5. IANA考虑

IANA has allocated the following value in the "PCP Options" registry (http://www.iana.org/assignments/pcp-parameters) from the optional-to-process range (see Section 19.4 of [RFC6887]):

IANA已在“PCP选项”注册表中分配了以下值(http://www.iana.org/assignments/pcp-parameters)从可选到工艺范围(见[RFC6887]第19.4节):

DESCRIPTION set to 128 (see Section 2)

说明设置为128(见第2节)

6. References
6. 工具书类
6.1. Normative References
6.1. 规范性引用文件

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.

[RFC2119]Bradner,S.,“RFC中用于表示需求水平的关键词”,BCP 14,RFC 2119,1997年3月。

[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD 63, RFC 3629, November 2003. [RFC6887] Wing, D., Ed., Cheshire, S., Boucadair, M., Penno, R., and P. Selkirk, "Port Control Protocol (PCP)", RFC 6887, April 2013.

[RFC3629]Yergeau,F.,“UTF-8,ISO 10646的转换格式”,STD 63,RFC 3629,2003年11月。[RFC6887]Wing,D.,Ed.,Cheshire,S.,Boucadair,M.,Penno,R.,和P.Selkirk,“港口控制协议(PCP)”,RFC 6887,2013年4月。

6.2. Informative References
6.2. 资料性引用

[PCP-DEPLOY] Boucadair, M., "Port Control Protocol (PCP) Deployment Models", Work in Progress, April 2014.

[PCP-DEPLOY]Boucadair,M.,“端口控制协议(PCP)部署模型”,正在进行的工作,2014年4月。

[RFC6462] Cooper, A., "Report from the Internet Privacy Workshop", RFC 6462, January 2012.

[RFC6462]Cooper,A.,“互联网隐私研讨会报告”,RFC 6462,2012年1月。

[RFC6970] Boucadair, M., Penno, R., and D. Wing, "Universal Plug and Play (UPnP) Internet Gateway Device - Port Control Protocol Interworking Function (IGD-PCP IWF)", RFC 6970, July 2013.

[RFC6970]Boucadair,M.,Penno,R.,和D.Wing,“通用即插即用(UPnP)互联网网关设备-端口控制协议互通功能(IGD-PCP IWF)”,RFC 69702013年7月。

Authors' Addresses

作者地址

Mohamed Boucadair France Telecom Rennes 35000 France

穆罕默德·布卡达尔法国电信雷恩35000法国

   EMail: mohamed.boucadair@orange.com
        
   EMail: mohamed.boucadair@orange.com
        

Reinaldo Penno Cisco USA

美国思科公司

   EMail: repenno@cisco.com
        
   EMail: repenno@cisco.com
        

Dan Wing Cisco Systems, Inc. 170 West Tasman Drive San Jose, California 95134 USA

Dan Wing Cisco Systems,Inc.美国加利福尼亚州圣何塞西塔斯曼大道170号,邮编95134

   EMail: dwing@cisco.com
        
   EMail: dwing@cisco.com