xref: /illumos-gate/usr/src/man/man3sip/sip_branchid.3sip (revision 3299f39fdcbdab4be7a9c70daa3873f2b78a398d)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SIP_BRANCHID 3SIP "Jan 25, 2007"
NAME
sip_branchid - generate a RFC 3261 complaint branch ID
SYNOPSIS

cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>

char *sip_branchid(sip_msg_t sip_msg);
DESCRIPTION

The sip_branchid() function can be used to generate a value for the branch parameter for a VIA header. The returned string is prefixed with z9hG4bK to conform to RFC 3261. If sip_msg is null or sip_msg does not have a VIA header, a random value is generated. Otherwise, the value is generated using the MD5 hash of the VIA, FROM, CALL-ID, CSEQ headers and the URI from the request line. The caller is responsible for freeing the returned string.

RETURN VALUES

The sip_branchid() function returns a string on success and NULL on failure.

The value of errno is not changed by these calls in the event of an error.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO

libsip(3LIB)