Proposal: Rename X_Requested_For to X_Forwarded_For

Status: Closed
Comment Period Closes: 12/17/2013
Affects Backwards Compatibility: YES
Relevant Issue: https://github.com/CybOXProject/schemas/issues/95

Background Information

CybOX 2.0.1 defines a X_Requested_For field within the HTTPRequestHeaderFieldsType found within the HTTP Session Object schema. This field does not represent a standard HTTP header field.

Proposal

We propose renaming the X_Requested_For field to X_Forwarded_For in CybOX 2.1. The following XML schema will be introduced to define the field:

<xs:element minOccurs="0" name="X_Forwarded_For" type="cyboxCommon:StringObjectPropertyType">
    <xs:annotation>
        <xs:documentation>The X-Forwarded-For field specifies the non-standard HTTP Request X-Forwarded-For field, which is typically used to identify the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer.</xs:documentation>
    </xs:annotation>
</xs:element>

Impact

Any HTTP Session Object instance data that exists which uses the CybOX 2.0.1 X_Requested_For field will no longer validate against the CybOX 2.1 schemas. Because this field did not represent a standard HTTP header, there should be minimal, if any, existing instance data that uses the field.

Requested Feedback

1. Are CybOX consumers and authors comfortable with breaking backwards compatibility for fixing this field?