Adds ComplianceRegion to Op protocol

Author: Andrew Mitchell

protocol/protocol.go

@@ -51,6 +51,8 @@ const (
 	TagJaegerSpan Tag = 0x15
 	// TagReqContext contains request metadata
 	TagReqContext Tag = 0x16
+	// TagComplianceRegion implies the compliance region of the operation which can impact behavior
+	TagComplianceRegion Tag = 0x17
 	// TagPadding implies an item with a meaningless payload added for padding.
 	TagPadding Tag = 0x20
 )
@@ -202,6 +204,25 @@ func (e Error) String() string {
 	}
 }
 
+// ComplianceRegion describes any guardrails that gokeyless should follow when accessing data from
+// external applications
+type ComplianceRegion byte
+
+const (
+	// ComplianceRegionFedRAMPHigh signals that this operation should only interact
+	// with the FedRAMP High QS instance
+	ComplianceRegionFedRAMPHigh ComplianceRegion = 0x01
+)
+
+func (cr ComplianceRegion) String() string {
+	switch cr {
+	case ComplianceRegionFedRAMPHigh:
+		return "fedramp_high"
+	default:
+		return "retail"
+	}
+}
+
 const (
 	paddedLength = 1024
 	headerSize   = 8
@@ -405,30 +426,32 @@ func (p *Packet) ReadFrom(r io.Reader) (n int64, err error) {
 
 // Operation defines a single (repeatable) keyless operation.
 type Operation struct {
-	Opcode         Op
-	Payload        []byte
-	Extra          []byte
-	SKI            SKI
-	Digest         Digest
-	ClientIP       net.IP
-	ServerIP       net.IP
-	SNI            string
-	CertID         string
-	ForwardingSvc  int64
-	CustomFuncName string
-	JaegerSpan     []byte
-	ReqContext     []byte
+	Opcode           Op
+	Payload          []byte
+	Extra            []byte
+	SKI              SKI
+	Digest           Digest
+	ClientIP         net.IP
+	ServerIP         net.IP
+	SNI              string
+	CertID           string
+	ForwardingSvc    int64
+	CustomFuncName   string
+	JaegerSpan       []byte
+	ReqContext       []byte
+	ComplianceRegion ComplianceRegion
 }
 
 func (o *Operation) String() string {
-	return fmt.Sprintf("[Opcode: %v, SKI: %v, Digest: %02x, Client IP: %s, Server IP: %s, SNI: %s, Forwarding Service: %v]",
+	return fmt.Sprintf("[Opcode: %v, SKI: %v, Digest: %02x, Client IP: %s, Server IP: %s, SNI: %s, Forwarding Service: %v, ComplianceRegion %v]",
 		o.Opcode,
 		o.SKI,
 		o.Digest,
 		o.ClientIP,
 		o.ServerIP,
 		o.SNI,
 		o.ForwardingSvc,
+		o.ComplianceRegion,
 	)
 }
 
@@ -512,6 +535,8 @@ func (o *Operation) Bytes() uint16 {
 	if o.ReqContext != nil {
 		add(tlvLen(len(o.ReqContext)))
 	}
+	// compliance region
+	add(tlvLen(1))
 	if int(length)+headerSize < paddedLength {
 		// TODO: Are we sure that's the right behavior?
 
@@ -586,6 +611,8 @@ func (o *Operation) MarshalBinary() ([]byte, error) {
 		b = append(b, tlvBytes(TagReqContext, o.ReqContext)...)
 	}
 
+	b = append(b, tlvBytes(TagComplianceRegion, []byte{byte(o.ComplianceRegion)})...)
+
 	if len(b)+headerSize < paddedLength {
 		// TODO: Are we sure that's the right behavior?
 
@@ -673,6 +700,11 @@ func (o *Operation) UnmarshalBinary(body []byte) error {
 			o.JaegerSpan = data
 		case TagReqContext:
 			o.ReqContext = data
+		case TagComplianceRegion:
+			if len(data) != 1 {
+				return fmt.Errorf("invalid ComplianceRegion: %s", data)
+			}
+			o.ComplianceRegion = ComplianceRegion(data[0])
 		default:
 			// Silently ignore any unknown tags (to allow for new tags to be gradually added to the protocol).
 			continue

protocol/protocol.md

@@ -39,6 +39,7 @@ The following tag values are possible for items:
     0x13 - CustomFuncName, (for use with opcode 0x24)
     0x14 - Supplemental payload, whose meaning is not specified and must be predetermined between the server and client,
     0x15 - Binary encoded Jaeger span (https://www.jaegertracing.io/docs/1.19/client-libraries/#value)
+    0x17 - ComplianceRegion,
 
 A requests contains a header and the following items: