ncidsip(8)

1NCIDSIP(8)                  System Manager's Manual                 NCIDSIP(8)
2
3
4

NAME

6       ncidsip - Inject CID info by snooping SIP invites
7

SYNOPSIS

9       ncidsip [options]
10
11       Options:
12
13       [-D                 | --debug]
14       [-d <filename>      | --dumpfile <filename>]
15       [-i <interface>     | --interface <interface>]
16       [-h                 | --help]
17       [-l                 | --list]
18       [-n <host[:port]>   | --ncid <host[:port]>]
19       [-s <[host][:port]> | --sip <[host][:port]>]
20       [-p <filename>      | --pidfile <filename>]
21       [-t                 | --test]
22       [-u                 | --usage]
23       [-V                 | --version]
24       [-v                 | --verbose]
25

DESCRIPTION

27       Snoops  SIP  Invites  via libpcap and injects the caller id information
28       found to the NCID server specified.  Uses Net::Pcap to  interface  with
29       the  libpcap  library  and snoops only udp traffic on the specified SIP
30       host and port.
31
32       The configuration file for ncidsip is /etc/ncid/ncidsip.conf.
33

OPTIONS

35       -s <[host][:port]> | --sip=<[host][:port]>
36              Specifies the hostname of the SIP devie to snoop.  You may  also
37              specify  the UDP port by suffixing the hostname with :<port>, or
38              if no hostname is wanted, just :<port>.  If you do not specify a
39              host, it defaults to the network interface.  If you do not spec‐
40              ify a port, it defaults to <5061> (Vonage default).  Other  Von‐
41              age ports are 5060 and 10000.  The new Vonage default appears to
42              be <10000>.
43
44       -n <host[:port]> | --ncid=<host[:port]>
45              Specifies the NCID server to connect to.  Port may be  specified
46              by suffixing the hostname with :<port>.  By default it will con‐
47              nect to port 3333 on "localhost".
48
49       -i <interface> | --interface=<interface>
50              Specifies the network interface to snoop on.   If  this  is  not
51              specified then libpcap will pick a network interface.  This will
52              generally be the first ethernet interface found.
53
54       -p <filename> | --pidfile=<filename>
55              Specifies the pidfile name  to  write.   Set  to  /var/run/ncid‐
56              sip.pid in a rc or init script when used as a service.  The pro‐
57              gram will still run if it does not have permission  to  write  a
58              pidfile.   There  is  no  default, if pidfile is not set, no pid
59              file will be used.
60
61       -h | --help
62              Prints this help
63
64       -D | --debug
65              Display the payload of all packets that matched the libpcap fil‐
66              ter.
67
68       -d <filename> | --dumpfile <filename>
69              Read packets from a libpcap capture file instead of the network.
70              Mostly only useful for development purposes.
71
72       -u | --usage
73              Prints this help
74
75       -V | --version
76              Displays the version
77
78       -v | --verbose
79              Displays status.  Use this option to run interactive.
80
81       -l | --listdevs
82              Returns a list of all network device names that can be used.
83
84       -t | --test
85              Test for SIP packets.  This option is used to check if SIP pack‐
86              ets exist without starting the NCID server.  It will display the
87              Caller ID line generated when a call comes in, and a CANCEL line
88              if cancel was generated.
89

FILES

91       /etc/ncid/ncidsip.conf
92

CID MESSAGE FORMAT

94       CID: ###DATEmmddhhss...LINEidentifier...NMBRnumber...NAMEwords+++
95
96   Example
97       CID: ###DATE05311233...LINE1122...NMBR13215551212...NAMEBig John+++
98

EXAMPLES

100       # run ncidsip as root and view status:
101       ncidsip -v
102
103       # run ncidsip as root and list all network device names:
104       ncidsip --listdevs
105
106       # run ncidsip as root and view SIP packets:
107       ncidsip --debug
108
109       # run sip from the init file at boot:
110       ncidsip
111