parser

package
v0.0.0-...-99cfb66 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 6, 2025 License: BSD-2-Clause Imports: 13 Imported by: 64

README

SIP parser

Package implements SIP protocol parser compatible with RFC 3261

Originally forked from gossip library by @StefanKopieczek.

Documentation

Overview

Forked from github.com/StefanKopieczek/gossip by @StefanKopieczek

Forked from github.com/StefanKopieczek/gossip by @StefanKopieczek

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetNextHeaderLine 

func GetNextHeaderLine(contents []string) (headerText string, consumed int)

GetNextHeaderLine extract the next logical header line from the message. This may run over several actual lines; lines that start with whitespace are a continuation of the previous line. Therefore also return how many lines we consumed so the parent parser can keep track of progress through the message.

func ParseAddressValue 

func ParseAddressValue(addressText string) (
	displayName sip.MaybeString,
	uri sip.Uri,
	headerParams sip.Params,
	err error,
)

ParseAddressValue parses an address - such as from a From, To, or Contact header. It returns:

  • a MaybeString containing the display name (or not)
  • a parsed SipUri object
  • a map containing any header parameters present
  • the error object

See RFC 3261 section 20.10 for details on parsing an address. Note that this method will not accept a comma-separated list of addresses; addresses in that form should be handled by ParseAddressValues.

func ParseAddressValues 

func ParseAddressValues(addresses string) (
	displayNames []sip.MaybeString,
	uris []sip.Uri,
	headerParams []sip.Params,
	err error,
)

ParseAddressValues parses a comma-separated list of addresses, returning any display names and header params, as well as the SIP URIs themselves. ParseAddressValues is aware of < > bracketing and quoting, and will not break on commas within these structures.

func ParseHostPort 

func ParseHostPort(rawText string) (host string, port *sip.Port, err error)

ParseHostPort parse a text representation of a host[:port] pair. The port may or may not be present, so we represent it with a *uint16, and return 'nil' if no port was present.

func ParseMessage 

func ParseMessage(msgData []byte, logger log.Logger) (sip.Message, error)

ParseMessage parse a SIP message by creating a parser on the fly.

func ParseParams 

func ParseParams(
	source string,
	start uint8,
	sep uint8,
	end uint8,
	quoteValues bool,
	permitSingletons bool,
) (params sip.Params, consumed int, err error)

ParseParams is a general utility method for parsing 'key=value' parameters. Takes a string (source), ensures that it begins with the 'start' character provided, and then parses successive key/value pairs separated with 'sep', until either 'end' is reached or there are no characters remaining. A map of keys to values will be returned, along with the number of characters consumed. Provide 0 for start or end to indicate that there is no starting/ending delimiter. If quoteValues is true, values can be enclosed in double-quotes which will be validated by the parser and omitted from the returned map. If permitSingletons is true, keys with no values are permitted. These will result in a nil value in the returned map.

func ParseRequestLine 

func ParseRequestLine(requestLine string) (
	method sip.RequestMethod, recipient sip.Uri, sipVersion string, err error)

ParseRequestLine parse the first line of a SIP request, e.g: 

INVITE bob@example.com SIP/2.0
REGISTER jane@telco.com SIP/1.0

func ParseSipUri 

func ParseSipUri(uriStr string) (uri sip.SipUri, err error)

ParseSipUri converts a string representation of a SIP or SIPS URI into a SipUri object.

func ParseStatusLine 

func ParseStatusLine(statusLine string) (
	sipVersion string, statusCode sip.StatusCode, reasonPhrase string, err error)

ParseStatusLine parse the first line of a SIP response, e.g: 

SIP/2.0 200 OK
SIP/1.0 403 Forbidden

func ParseUri 

func ParseUri(uriStr string) (uri sip.Uri, err error)

ParseUri converts a string representation of a URI into a Uri object. If the URI is malformed, or the URI schema is not recognised, an error is returned. URIs have the general form of schema:address.

func SplitByWhitespace 

func SplitByWhitespace(text string) []string

SplitByWhitespace splits the given string into sections, separated by one or more characters from c_ABNF_WS.

Types

type Error 

type Error interface {
	error
	// Syntax indicates that this is syntax error
	Syntax() bool
}

type HeaderParser 

type HeaderParser func(headerName string, headerData string) ([]sip.Header, error)

A HeaderParser is any function that turns raw header data into one or more Header objects. The HeaderParser will receive arguments of the form ("max-forwards", "70"). It should return a slice of headers, which should have length > 1 unless it also returns an error.

type InvalidMessageFormat 

type InvalidMessageFormat string

func (InvalidMessageFormat) Broken 

func (err InvalidMessageFormat) Broken() bool

func (InvalidMessageFormat) Error 

func (err InvalidMessageFormat) Error() string

func (InvalidMessageFormat) Malformed 

func (err InvalidMessageFormat) Malformed() bool

func (InvalidMessageFormat) Syntax 

func (err InvalidMessageFormat) Syntax() bool

type InvalidStartLineError 

type InvalidStartLineError string

func (InvalidStartLineError) Broken 

func (err InvalidStartLineError) Broken() bool

func (InvalidStartLineError) Error 

func (err InvalidStartLineError) Error() string

func (InvalidStartLineError) Malformed 

func (err InvalidStartLineError) Malformed() bool

func (InvalidStartLineError) Syntax 

func (err InvalidStartLineError) Syntax() bool

type PacketParser 

type PacketParser struct {
	// contains filtered or unexported fields
}

func NewPacketParser 

func NewPacketParser(logger log.Logger) *PacketParser

func (*PacketParser) Log 

func (pp *PacketParser) Log() log.Logger

func (*PacketParser) ParseHeader 

func (pp *PacketParser) ParseHeader(headerText string) (headers []sip.Header, err error)

ParseHeader parse a header string, producing one or more Header objects. (SIP messages containing multiple headers of the same type can express them as a single header containing a comma-separated argument list).

func (*PacketParser) ParseMessage 

func (pp *PacketParser) ParseMessage(data []byte) (sip.Message, error)

func (*PacketParser) SetHeaderParser 

func (pp *PacketParser) SetHeaderParser(headerName string, headerParser HeaderParser)

SetHeaderParser implements ParserFactory.SetHeaderParser.

func (*PacketParser) String 

func (pp *PacketParser) String() string

type Parser 

type Parser interface {
	// Write implements io.Writer. Queues the given bytes to be parsed.
	// If the parser has terminated due to a previous fatal error, it will return n=0 and an appropriate error.
	// Otherwise, it will return n=len(p) and err=nil.
	// Note that err=nil does not indicate that the data provided is valid - simply that the data was successfully queued for parsing.
	Write(p []byte) (n int, err error)
	// SetHeaderParser register a custom header parser for a particular header type.
	// This will overwrite any existing registered parser for that header type.
	// If a parser is not available for a header type in a message, the parser will produce a core.GenericHeader struct.
	SetHeaderParser(headerName string, headerParser HeaderParser)

	Stop()

	String() string
	// Reset resets parser state
	Reset()

	ParseHeader(headerText string) (headers []sip.Header, err error)
}

A Parser converts the raw bytes of SIP messages into core.Message objects. It allows

func NewParser 

func NewParser(
	output chan<- sip.Message,
	errs chan<- error,
	streamed bool,
	logger log.Logger,
) Parser

NewParser create a new Parser.

Parsed SIP messages will be sent down the 'output' chan provided. Any errors which force the parser to terminate will be sent down the 'errs' chan provided.

If streamed=false, each Write call to the parser should contain data for one complete SIP message. If streamed=true, Write calls can contain a portion of a full SIP message. The end of one message and the start of the next may be provided in a single call to Write. When streamed=true, all SIP messages provided must have a Content-Length header. SIP messages without a Content-Length will cause the parser to permanently stop, and will result in an error on the errs chan.

'streamed' should be set to true whenever the caller cannot reliably identify the starts and ends of messages from the transport frames, e.g. when using streamed protocols such as TCP.

type WriteError 

type WriteError string

func (WriteError) Error 

func (err WriteError) Error() string

func (WriteError) Syntax 

func (err WriteError) Syntax() bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.