xref: /freebsd/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 (revision 87569f75a91f298c52a71823c04d41cf53c88889)
1.\" Copyright (c) 2001-2003 Maksim Yevmenkin <m_evmenkin@yahoo.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: rfcomm_pppd.8,v 1.7 2003/09/07 18:32:11 max Exp $
26.\" $FreeBSD$
27.\"
28.Dd February 4, 2003
29.Dt RFCOMM_PPPD 8
30.Os
31.Sh NAME
32.Nm rfcomm_pppd
33.Nd RFCOMM PPP daemon
34.Sh SYNOPSIS
35.Nm
36.Fl c
37.Op Fl dh
38.Fl a Ar address
39.Fl C Ar channel
40.Fl l Ar label
41.Fl u Ar N
42.Nm
43.Fl s
44.Op Fl dhS
45.Op Fl a Ar address
46.Fl C Ar channel
47.Fl l Ar label
48.Sh DESCRIPTION
49The
50.Nm
51daemon is a simple wrapper daemon that allows to use standard
52.Xr ppp 8
53on RFCOMM connection.
54It can operate in two modes: client and server.
55.Pp
56In the client mode,
57.Nm
58opens an RFCOMM connection to the specified server's
59.Ar BD_ADRR
60and
61.Ar channel .
62Once RFCOMM connection is established,
63.Nm
64executes
65.Xr ppp 8
66in
67.Fl direct
68mode with the specified
69.Ar label .
70The
71.Xr ppp 8
72in its turn operates over the RFCOMM connection just like it would operate
73over the standard serial port thus allowing user to
74.Dq "dial out"
75and connect to the Internet.
76.Pp
77In the server mode,
78.Nm
79opens an RFCOMM socket and listens for incoming connections from remote clients.
80Once the new incoming connection is accepted,
81.Nm
82forks and executes
83.Xr ppp 8
84in
85.Fl direct
86mode with the specified
87.Ar label .
88The
89.Xr ppp 8
90in its turn operates over the RFCOMM connection just like it would operate over
91the standard serial port thus providing network connectivity to remote clients.
92.Pp
93The options are as follows:
94.Bl -tag -width indent
95.It Fl a Ar address
96In the client mode, this required option specifies the address of the remote
97RFCOMM server.
98In the server mode, this option can be used to specify the local
99address to listen on.
100By default, server will listen on
101.Dv ANY
102address.
103The address can be specified as BD_ADDR or name.
104If name was specified then the
105.Nm
106utility will attempt to resolve the name via
107.Xr bt_gethostbyname 3 .
108.It Fl C Ar channel
109In both client and server modes, this required option specifies RFCOMM channel
110to connect to or listen on.
111In the server mode, RFCOMM channel should be a number between 1 and 30.
112In the client mode, RFCOMM channel could either be a number between 1 and 30
113or a service name.
114Supported service names are:
115.Cm DUN
116(for DialUp Networking service) and
117.Cm LAN
118(for LAN Access Using PPP service).
119If service name was specified instead of numeric RFCOMM channel then
120.Nm
121utility will try to obtain RFCOMM channel for the service via Service
122Discovery Protocol.
123.It Fl c
124Act as an RFCOMM client.
125This is the default mode.
126.It Fl d
127Do not detach from the controlling terminal, i.e., run in foreground.
128.It Fl h
129Display usage message and exit.
130.It Fl l Ar label
131In both client and server modes, this required option specifies which
132.Xr ppp 8
133label will be used.
134.It Fl S
135In the server mode, register the Serial Port (SP) service in addition to the
136LAN Access Using PPP (LAN) service.
137It appears that some cell phones are using the so-called
138.Dq "callback mechanism" .
139In this scenario, the user is trying to connect his cell phone to the Internet,
140and user's host computer is acting as the gateway server.
141It seems that it is not possible to tell the phone to just connect and start
142using the LAN service.
143Instead, the user's host computer must
144.Dq "jump start"
145the phone by connecting to the phone's SP service.
146What happens next is the phone kills the existing connection and opens another
147connection back to the user's host computer.
148The phone really wants to use LAN service, but for whatever reason it looks
149for the SP service on the user's host computer.
150This brain damaged behavior was reported for Nokia 6600 and Sony/Ericsson P900.
151.It Fl s
152Act as an RFCOMM server.
153.It Fl u Ar N
154This option maps directly onto
155.Fl unit
156.Xr ppp 8
157command line option and tells
158.Nm
159to instruct
160.Xr ppp 8
161to only attempt to open
162.Pa /dev/tun Ns Ar N .
163This option only works in the client mode.
164.El
165.Sh PPP CONFIGURATION
166.Ss Important Notes on PPP Configuration
167Special attention is required when adding new RFCOMM configurations to the
168existing PPP configuration.
169Please keep in mind that PPP will
170.Em always
171execute commands in the
172.Dq Li default
173label of your
174.Pa /etc/ppp/ppp.conf
175file.
176Please make sure that the
177.Dq Li default
178label
179.Em only
180contains commands that apply to
181.Em every
182other label.
183If you need to use PPP for both dialing out and accepting incoming
184RFCOMM connections, please make sure you have moved all commands related to
185dialing out from the
186.Dq Li default
187section into an appropriate outgoing label.
188.Ss RFCOMM Server
189One of the typical examples is the LAN access.
190In this example, RFCOMM connection
191is used as a null-modem connection between client and server.
192Both client
193and server will start talking PPP right after RFCOMM connection was established.
194.Bd -literal -offset indent
195rfcomm-server:
196 set timeout 0
197 set lqrperiod 10
198 set ifaddr 10.0.0.1 10.0.0.2 255.255.255.0
199 enable lqr
200 accept lqr
201 # Do not use PPP authentication. Assume that
202 # Bluetooth connection was authenticated already
203 disable pap
204 deny pap
205 disable chap
206 deny chap
207.Ed
208.Ss RFCOMM Client
209The
210.Nm
211utility
212supports both LAN and DUN (Dial-Up Networking) access.
213The client's configuration for the LAN access is very similar to server's and
214might look like this.
215.Bd -literal -offset indent
216rfcomm-client:
217 enable lqr
218 accept lqr
219 set dial
220 set timeout 0
221 disable iface-alias
222 set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.0 0.0.0.0
223 # Do not use PPP authentication. Assume that
224 # Bluetooth connection was authenticated already
225 deny pap
226 disable pap
227 deny chap
228 disable chap
229.Ed
230.Pp
231The client's configuration for the DUN access is different.
232In this scenario, the client gets connected to the virtual serial port on the
233server.
234To open a PPP session, client must dial a number.
235Note that by default
236.Xr ppp 8
237will not execute any configured chat scripts.
238The
239.Ic force-scripts
240option can be used to override this behavior.
241The example of such configuration is shown below.
242.Bd -literal -offset indent
243rfcomm-dialup:
244 # This is IMPORTANT option
245 enable force-scripts
246
247 # You might want to change these
248 set authname
249 set authkey
250 set phone "*99***1#"
251
252 # You might want to adjust dial string as well
253 set dial "ABORT BUSY ABORT NO\\\\sCARRIER TIMEOUT 5 \\
254           \\"\\" AT OK-AT-OK ATE1Q0 OK \\\\dATDT\\\\T TIMEOUT 40 CONNECT"
255 set login
256 set timeout 30
257 enable dns
258 resolv rewrite
259
260 set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.0 0.0.0.0
261 add default HISADDR
262.Ed
263.Pp
264Note that by adjusting the initialization string, one can make CSD (Circuit
265Switched Data), HSCSD (High Speed Circuit Switched Data) or GPRS (General
266Packet Radio Service) connection.
267The availability of the particular connection
268type depends on the phone model and service plan activated on the phone.
269.Sh EXIT STATUS
270.Ex -std
271.Sh EXAMPLES
272.Dl "rfcomm_pppd -s -a 00:01:02:03:04:05 -C 1 -l rfcomm-server"
273.Pp
274This command will start
275.Nm
276in the server mode.
277The RFCOMM server will listen on local address
278.Li 00:01:02:03:04:05
279and channel
280.Li 1 .
281Once the incoming connection has been accepted,
282.Nm
283will execute
284.Xr ppp 8
285in
286.Fl direct
287mode with
288.Dq Li rfcomm-server
289label.
290.Pp
291.Dl "rfcomm_pppd -c -a 00:01:02:03:04:05 -C 1 -l rfcomm-client"
292.Pp
293This command will start
294.Nm
295in the client mode.
296.Nm
297will try to connect to the RFCOMM server at
298.Li 00:01:02:03:04:05
299address and channel
300.Li 1 .
301Once connected, the
302.Nm
303will execute
304.Xr ppp 8
305in
306.Fl direct
307mode with
308.Dq Li rfcomm-client
309label.
310.Sh CAVEAT
311The
312.Nm
313utility in server mode will try to register Bluetooth LAN Access Over PPP
314service with local SPD daemon.
315If local SDP daemon is not running the
316.Nm
317utility will exit with error.
318.Sh SEE ALSO
319.Xr rfcomm_sppd 1 ,
320.Xr bluetooth 3 ,
321.Xr ng_btsocket 4 ,
322.Xr ppp 8 ,
323.Xr sdpcontrol 8 ,
324.Xr sdpd 8
325.Sh AUTHORS
326.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
327