Updated docs and added explicit return code for * Contact when it fails

Author: davidtrihy-genesys

modules/sipmsgops/doc/sipmsgops_admin.xml

@@ -964,7 +964,8 @@ add_body_part("Hello World!", "text/plain");
 				<listitem><para><emphasis>'t'</emphasis> - checks the URI of the 'To' field
 						and whether the domain contains valid characters.
 				</para></listitem>
-				<listitem><para><emphasis>'c'</emphasis> - checks the URI of the 'Contact' field.
+				<listitem><para><emphasis>'c'</emphasis> - checks the value of the 'Contact' field
+						and whether it is a Uri, Star - for REGISTER requests with Expires header set to 0.
 				</para></listitem>
 			</itemizedlist>
 		</para>
@@ -1035,6 +1036,8 @@ add_body_part("Hello World!", "text/plain");
 				</para></listitem>
 				<listitem><para><emphasis>-29</emphasis> - Bad To URI username
 				</para></listitem>
+				<listitem><para><emphasis>-30</emphasis> - Contact header contains * for non-Register request
+				</para></listitem>
 				<listitem><para><emphasis>-255</emphasis> - undefined errors.
 				</para></listitem>
 			</itemizedlist>
@@ -1062,6 +1065,15 @@ if(!sipmsg_validate("sh", $var(err_reason)))
 	exit;
 }
 ...
+
+...
+# checks Contact header for a 200 Ok reply and logs when it's *
+if(!sipmsg_validate("c"))
+{
+	if ($rc == -30)
+		xlog("Invalid * Contact header found\n");
+}
+...
 </programlisting>
 		</example>
 	</section>

modules/sipmsgops/sipmsgops.c

@@ -1610,29 +1610,31 @@ enum sip_validation_failures {
 	SV_BAD_USERNAME=-27,
 	SV_FROM_USERNAME_ERROR=-28,
 	SV_TO_USERNAME_ERROR=-29,
-	SV_BAD_EXPIRES=-30,
+	SV_BAD_STAR_CONTACT=-30,
 	SV_GENERIC_FAILURE=-255
 };
 
 #define METHOD_WITH_CONTACT_HDR (METHOD_INVITE | METHOD_REGISTER | METHOD_UPDATE | METHOD_SUBSCRIBE | METHOD_REFER)
 
 static enum sip_validation_failures validate_contact_header(struct sip_msg *msg, enum request_method method, char reason[static MAX_REASON])
 {
-	struct hdr_field *ptr = NULL, *expires = NULL;
+	struct hdr_field *ptr = NULL;
 	contact_t * contacts = NULL;
-	contact_body_t *contact_body = NULL;
 	exp_body_t *expires_body = NULL;
 	struct sip_uri test_contacts;
-	enum sip_validation_failures ret;
+	enum sip_validation_failures ret = SV_NO_ERROR;
 
 	if (method & METHOD_WITH_CONTACT_HDR) {
-		ret = SV_NO_CONTACT;
-		CHECK_HEADER("", contact);
+		if (!msg->contact) {
+			strcpy(reason, "SIP message doesn't have 'Contact' header");
+			ret = SV_NO_CONTACT;
+			goto failed;
+		}
 
 		/* iterate through Contact headers */
 		for(ptr = msg->contact; ptr; ptr = ptr->sibling) {
 			/* parse Contact header */
-			if(!ptr->parsed && (parse_contact(ptr) < 0
+			if (!ptr->parsed && (parse_contact(ptr) < 0
 						|| !ptr->parsed)) {
 				strcpy(reason, "failed to parse 'Contact' header");
 				ret = SV_CONTACT_PARSE_ERROR;
@@ -1652,34 +1654,36 @@ static enum sip_validation_failures validate_contact_header(struct sip_msg *msg,
 					}
 				}
 			} else {
-				/* empty contacts header - this can be a * Contact header, valid only for REGISTER requests */
-				contact_body = (contact_body_t *) msg->contact->parsed;
+				/* This is a star Contact header, valid only for REGISTER requests */
+				if (method == METHOD_REGISTER) {
+					if (msg->first_line.type == SIP_REPLY) {
+						strcpy(reason, "'Contact' header for REGISTER reply contains '*' only valid for REGISTER request");
+						ret = SV_BAD_STAR_CONTACT;
+						goto failed;
+					}
 
-				if (method != METHOD_REGISTER || msg->first_line.type == SIP_REPLY) {
-					strcpy(reason, "empty body for 'Contact' header");
-					ret = SV_CONTACT_PARSE_ERROR;
-					goto failed;
-				} else {
 					if (!msg->expires || (parse_expires(msg->expires) < 0 || !msg->expires->parsed)) {
 						strcpy(reason, "failed to parse 'Expires' header");
-						ret = SV_BAD_EXPIRES;
+						ret = SV_BAD_STAR_CONTACT;
 						goto failed;
 					}
 
 					expires_body = (exp_body_t*) msg->expires->parsed;
 
-					if (!expires_body || !(expires_body->val == 0 && contact_body->star == 1)) {
-						strcpy(reason, "Expires header greater than 0 for REGISTER 'Contact' header with '*' value");
-						ret = SV_CONTACT_PARSE_ERROR;
+					if (!expires_body || expires_body->val != 0) {
+						strcpy(reason, "'Expires' header greater than 0 for REGISTER 'Contact' header with '*' value");
+						ret = SV_BAD_STAR_CONTACT;
 						goto failed;
 					}
+				} else {
+					strcpy(reason, "'Contact' header for SIP message contains '*' only valid for REGISTER request");
+					ret = SV_BAD_STAR_CONTACT;
+					goto failed;
 				}
 			}
 		}
 	}
 
-	ret = SV_NO_ERROR;
-
 failed:
 	return ret;
 }
@@ -1912,7 +1916,7 @@ static int w_sip_validate(struct sip_msg *msg, void *_flags, pv_spec_t* err_txt)
 				}
 			}
 
-			if (flags & SIP_PARSE_CONTACT && (status_code > 199 || status_code < 400)) {
+			if (flags & SIP_PARSE_CONTACT && (status_code > 199 && status_code < 400)) {
 				ret = validate_contact_header(msg, method, reason);
 
 				if (ret != 0) {