4 ### Service for establishing dynamic connections
6 ### (c) 2006 Straylight/Edgeware
9 ###----- Licensing notice ---------------------------------------------------
11 ### This file is part of Trivial IP Encryption (TrIPE).
13 ### TrIPE is free software; you can redistribute it and/or modify
14 ### it under the terms of the GNU General Public License as published by
15 ### the Free Software Foundation; either version 2 of the License, or
16 ### (at your option) any later version.
18 ### TrIPE is distributed in the hope that it will be useful,
19 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ### GNU General Public License for more details.
23 ### You should have received a copy of the GNU General Public License
24 ### along with TrIPE; if not, write to the Free Software Foundation,
25 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 ###--------------------------------------------------------------------------
30 ### External dependencies.
32 from optparse import OptionParser
41 ###--------------------------------------------------------------------------
42 ### Main service machinery.
44 _magic = ['_magic'] # An object distinct from all others
47 """Representation of a peer in the database."""
49 def __init__(me, peer, cdb = None):
51 Create a new peer, named PEER.
53 Information about the peer is read from the database CDB, or the default
54 one given on the command-line.
58 record = (cdb or CDB.init(opts.cdb))['P' + peer]
60 raise T.TripeJobError('unknown-peer', peer)
61 me.__dict__.update(M.URLDecode(record, semip = True))
63 def get(me, key, default = _magic):
65 Get the information stashed under KEY from the peer's database record.
67 If DEFAULT is given, then use it if the database doesn't contain the
68 necessary information. If no DEFAULT is given, then report an error.
70 attr = me.__dict__.get(key, default)
72 raise T.TripeJobError('malformed-peer', me.name, 'missing-key', key)
77 Iterate over the available keys in the peer's database record.
79 return me.__dict__.iterkeys()
81 def addpeer(peer, addr):
83 Process a connect request from a new peer PEER on address ADDR.
85 Any existing peer with this name is disconnected from the server.
87 if peer.name in S.list():
90 booltrue = ['t', 'true', 'y', 'yes', 'on']
92 tunnel = peer.get('tunnel', None),
93 keepalive = peer.get('keepalive', None),
94 key = peer.get('key', None),
95 priv = peer.get('priv', None),
96 mobile = peer.get('mobile', 'nil') in booltrue,
97 cork = peer.get('cork', 'nil') in booltrue,
99 except T.TripeError, exc:
100 raise T.TripeJobError(*exc.args)
102 def cmd_active(name):
104 active NAME: Handle an active connection request for the peer called NAME.
106 The appropriate address is read from the database automatically.
109 addr = peer.get('peer')
110 if addr == 'PASSIVE':
111 raise T.TripeJobError('passive-peer', name)
112 addpeer(peer, M.split(addr, quotep = True)[0])
116 list: Report a list of the available active peers.
118 cdb = CDB.init(opts.cdb)
119 for key in cdb.keys():
120 if key.startswith('P') and Peer(key[1:]).get('peer', '') != 'PASSIVE':
125 info NAME: Report the database entries for the named peer.
128 items = list(peer.list())
131 T.svcinfo('%s=%s' % (i, peer.get(i)))
133 def cmd_userpeer(user):
135 userpeer USER: Report the peer name for the named user.
138 peer = CDB.init(opts.cdb)['U' + user]
140 raise T.TripeJobError('unknown-user', user)
143 ## Dictionary mapping challenges to waiting passive-connection coroutines.
146 def cmd_passive(*args):
148 passive [OPTIONS] USER: Await the arrival of the named USER.
150 Report a challenge; when (and if!) the server receives a greeting quoting
151 this challenge, add the corresponding peer to the server.
154 op = T.OptParse(args, ['-timeout'])
156 if opt == '-timeout':
157 timeout = T.timespec(op.arg())
158 user, = op.rest(1, 1)
160 peer = CDB.init(opts.cdb)['U' + user]
162 raise T.TripeJobError('unknown-user', user)
164 cr = T.Coroutine.getcurrent()
165 timer = M.SelTimer(time() + timeout, lambda: cr.switch(None))
169 addr = cr.parent.switch()
171 raise T.TripeJobError('connect-timeout')
172 addpeer(Peer(peer), addr)
176 def notify(_, code, *rest):
178 Watch for notifications.
180 In particular, if a GREETing appears quoting a challenge in the chalmap
181 then wake up the corresponding coroutine.
188 chalmap[chal].switch(addr)
190 ###--------------------------------------------------------------------------
197 Register the notification-watcher, and add the automatic active peers.
199 S.handler['NOTE'] = notify
202 cdb = CDB.init(opts.cdb)
207 for name in M.split(autos)[0]:
209 peer = Peer(name, cdb)
210 addpeer(peer, M.split(peer.get('peer'), quotep = True)[0])
211 except T.TripeJobError, err:
212 S.warn('connect', 'auto-add-failed', name, *err.args)
216 Parse the command-line options.
218 Automatically changes directory to the requested configdir, and turns on
219 debugging. Returns the options object.
221 op = OptionParser(usage = '%prog [-a FILE] [-d DIR]',
222 version = '%%prog %s' % VERSION)
224 op.add_option('-a', '--admin-socket',
225 metavar = 'FILE', dest = 'tripesock', default = T.tripesock,
226 help = 'Select socket to connect to [default %default]')
227 op.add_option('-d', '--directory',
228 metavar = 'DIR', dest = 'dir', default = T.configdir,
229 help = 'Select current diretory [default %default]')
230 op.add_option('-p', '--peerdb',
231 metavar = 'FILE', dest = 'cdb', default = T.peerdb,
232 help = 'Select peers database [default %default]')
233 op.add_option('--daemon', dest = 'daemon',
234 default = False, action = 'store_true',
235 help = 'Become a daemon after successful initialization')
236 op.add_option('--debug', dest = 'debug',
237 default = False, action = 'store_true',
238 help = 'Emit debugging trace information')
239 op.add_option('--startup', dest = 'startup',
240 default = False, action = 'store_true',
241 help = 'Being called as part of the server startup')
243 opts, args = op.parse_args()
244 if args: op.error('no arguments permitted')
246 T._debug = opts.debug
249 ## Service table, for running manually.
250 service_info = [('connect', VERSION, {
251 'passive': (1, None, '[OPTIONS] USER', cmd_passive),
252 'active': (1, 1, 'PEER', cmd_active),
253 'info': (1, 1, 'PEER', cmd_info),
254 'list': (0, 0, '', cmd_list),
255 'userpeer': (1, 1, 'USER', cmd_userpeer)
258 if __name__ == '__main__':
259 opts = parse_options()
260 T.runservices(opts.tripesock, service_info,
262 daemon = opts.daemon)
264 ###----- That's all, folks --------------------------------------------------