SIPGO is library for writing fast SIP services in GO language.
It comes with SIP stack (RFC 3261|RFC3581) optimized for fast parsing.
For experimental features checkout also
github.com/emiago/sipgox
It adds media, call, dialog creation on top of sipgo more easily.
Fetch lib with:
go get github.com/emiago/sipgo
NOTE: LIB MAY HAVE API CHANGES UNTIL STABLE VERSION.
To keep project development you can support it
Also, if you are using lib in any way, let us known, we would like to share it here.
You can follow on X/Twitter for more updates.
- UDP
- TCP
- TLS
- WS
- WSS
- Stateful proxy example/proxysip
- Register with authentication example/register
- RTP echo with sipgox example/dialog
Also thanks to pion project sharing this example of using SIPgo with webrtc:
- CLI softphone for easy testing gophone
- Simple proxy where NAT is problem psip
- ... your tool can be here
As example you can find example/proxysip
as simple version of statefull proxy. It is used for stress testing with sipp
.
To find out more about performance check the latest results:
example/proxysip
![babelforce](https://raw.githubusercontent.com/azhaocn/sipgo/main/icons/babelforce-logo.png)
Lib allows you to write easily sip servers, clients, stateful proxies, registrars or any sip routing. Writing in GO we are not limited to handle SIP requests/responses in many ways, or to integrate and scale with any external services (databases, caches...).
Using server or client handle for UA you can build incoming or outgoing requests.
ua, _ := sipgo.NewUA() // Build user agent
srv, _ := sipgo.NewServer(ua) // Creating server handle
client, _ := sipgo.NewClient(ua) // Creating client handle
srv.OnInvite(inviteHandler)
srv.OnAck(ackHandler)
srv.OnCancel(cancelHandler)
srv.OnBye(byeHandler)
// For registrars
// srv.OnRegister(registerHandler)
ctx, _ := signal.NotifyContext(ctx, os.Interrupt)
go srv.ListenAndServe(ctx, "udp", "127.0.0.1:5060")
go srv.ListenAndServe(ctx, "tcp", "127.0.0.1:5061")
go srv.ListenAndServe(ctx, "ws", "127.0.0.1:5080")
<-ctx.Done()
- Server handle creates listeners and reacts on incoming requests. More on server transactions
- Client handle allows creating transaction requests More on client transactions
// TLS
conf := sipgo.GenerateTLSConfig(certFile, keyFile, rootPems)
srv.ListenAndServeTLS(ctx, "tcp", "127.0.0.1:5061", conf)
srv.ListenAndServeTLS(ctx, "ws", "127.0.0.1:5081", conf)
Server transaction is passed on handler
// Incoming request
srv.OnInvite(func(req *sip.Request, tx sip.ServerTransaction) {
res := sip.NewResponseFromRequest(req, code, reason, body)
// Send response
tx.Respond(res)
select {
case m := <-tx.Acks(): // Handle ACK . ACKs on 2xx are send as different request
case m := <-tx.Cancels(): // Handle Cancel
case <-tx.Done():
// Signal transaction is done.
// Check any errors with tx.Err() to have more info why terminated
return
}
// terminating handler terminates Server transaction automaticaly
})
srv := sipgo.NewServer()
...
func ackHandler(req *sip.Request, tx sip.ServerTransaction) {
res := sip.NewResponseFromRequest(req, code, reason, body)
srv.WriteResponse(res)
}
srv.OnACK(ackHandler)
Using client handle allows easy creating and sending request.
Unless you customize transaction request with opts by default client.TransactionRequest
will build all other
headers needed to pass correct sip request.
Here is full example:
ctx := context.Background()
client, _ := sipgo.NewClient(ua) // Creating client handle
// Request is either from server request handler or created
req.SetDestination("10.1.2.3") // Change sip.Request destination
tx, err := client.TransactionRequest(ctx, req) // Send request and get client transaction handle
defer tx.Terminate() // Client Transaction must be terminated for cleanup
...
select {
case res := <-tx.Responses():
// Handle responses
case <-tx.Done():
// Wait for termination
return
}
client, _ := sipgo.NewClient(ua) // Creating client handle
req := sip.NewRequest(method, &recipment)
// Send request and forget
client.WriteRequest(req)
DialogClient
and DialogServer
allow easier managing multiple dialog (Calls) sessions.
They are seperated based on your request context, but they act more like peer
.
They both need client
handle to be able send request and server
handle to accept request.
UAC:
ua, _ := sipgo.NewUA() // Build user agent
srv, _ := sipgo.NewServer(ua) // Creating server handle
client, _ := sipgo.NewClient(ua) // Creating client handle
contactHDR := sip.ContactHeader{
Address: sip.Uri{User: "test", Host: "127.0.0.200", Port: 5088},
}
dialogCli := sipgo.NewDialogClient(client, contactHDR)
// Attach Bye handling for dialog
srv.OnBye(func(req *sip.Request, tx sip.ServerTransaction) {
err := dialogCli.ReadBye(req, tx)
//handle error
})
// Create dialog session
dialog, err := dialogCli.Invite(ctx, recipientURI, nil)
defer dialog.Close() // Cleans up from dialog pool
// Wait for answer
err = dialog.WaitAnswer(ctx, AnswerOptions{})
// Check dialog response dialog.InviteResponse (SDP) and return ACK
err = dialog.Ack(ctx)
// Send BYE to terminate call
err = dialog.Bye(ctx)
UAS:
ua, _ := sipgo.NewUA() // Build user agent
srv, _ := sipgo.NewServer(ua) // Creating server handle
client, _ := sipgo.NewClient(ua) // Creating client handle
uasContact := sip.ContactHeader{
Address: sip.Uri{User: "test", Host: "127.0.0.200", Port: 5099},
}
dialogSrv := sipgo.NewDialogServer(client, uasContact)
srv.OnInvite(func(req *sip.Request, tx sip.ServerTransaction) {
dlg, err := dialogSrv.ReadInvite(req, tx)
// handle error
dlg.Respond(sip.StatusTrying, "Trying", nil)
dlg.Respond(sip.StatusOK, "OK", nil)
// Instead Done also dlg.State() can be used for granular state checking
<-dlg.Done()
})
srv.OnAck(func(req *sip.Request, tx sip.ServerTransaction) {
dialogSrv.ReadAck(req, tx)
})
srv.OnBye(func(req *sip.Request, tx sip.ServerTransaction) {
dialogSrv.ReadBye(req, tx)
})
Proxy is combination client and server handle that creates server/client transaction. They need to share same ua same like uac/uas build.
Forwarding request is done via client handle:
ua, _ := sipgo.NewUA() // Build user agent
srv, _ := sipgo.NewServer(ua) // Creating server handle
client, _ := sipgo.NewClient(ua) // Creating client handle
srv.OnInvite(func(req *sip.Request, tx sip.ServerTransaction) {
ctx := context.Background()
req.SetDestination("10.1.2.3") // Change sip.Request destination
// Start client transaction and relay our request. Add Via and Record-Route header
clTx, err := client.TransactionRequest(ctx, req, sipgo.ClientRequestAddVia, sipgo.ClientRequestAddRecordRoute)
// Send back response
res := <-cltx.Responses()
tx.Respond(res)
})
You can have full SIP messages dumped from transport into Debug level message.
Example:
sip.SIPDebug = true
Feb 24 23:32:26.493191 DBG UDP read 10.10.0.10:5060 <- 10.10.0.100:5060:
SIP/2.0 100 Trying
Via: SIP/2.0/UDP 10.10.0.10:5060;rport=5060;received=10.10.0.10;branch=z9hG4bK.G3nCwpXAKJQ0T2oZUII70wuQx9NeXc61;alias
Via: SIP/2.0/UDP 10.10.1.1:5060;branch=z9hG4bK-1-1-0
Record-Route: <sip:10.10.0.10;transport=udp;lr>
Call-ID: 1-1@10.10.1.1
From: "sipp" <sip:sipp@10.10.1.1>;tag=1SIPpTag001
To: "uac" <sip:uac@10.10.0.10>
CSeq: 1 INVITE
Server: Asterisk PBX 18.16.0
Content-Length: 0
More on documentation you can find on Go doc
If you are interested using lib for your testing services then checkout article on how easy you can make calls and other
Coverage: 36.7%
Library will be covered with more tests. Focus is more on benchmarking currently.
go test ./...
This project was influenced by gosip, project by @ghetovoice, but started as new project to achieve best/better performance and to improve API. This unfortunately required many design changes, therefore this libraries are not compatible.
If you find this project interesting for bigger support or contributing, you can contact me on mail
For bugs features pls create issue.