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():
91 tunnel = peer.get('tunnel', None),
92 keepalive = peer.get('keepalive', None),
93 cork = peer.get('cork', 'nil') in ['t', 'true', 'y', 'yes', 'on'],
95 except T.TripeError, exc:
96 raise T.TripeJobError(*exc.args)
100 active NAME: Handle an active connection request for the peer called NAME.
102 The appropriate address is read from the database automatically.
105 addr = peer.get('peer')
106 if addr == 'PASSIVE':
107 raise T.TripeJobError('passive-peer', name)
108 addpeer(peer, M.split(addr, quotep = True)[0])
112 list: Report a list of the available active peers.
114 cdb = CDB.init(opts.cdb)
115 for key in cdb.keys():
116 if key.startswith('P') and Peer(key[1:]).get('peer', '') != 'PASSIVE':
121 info NAME: Report the database entries for the named peer.
124 items = list(peer.list())
127 T.svcinfo('%s=%s' % (i, peer.get(i)))
129 ## Dictionary mapping challenges to waiting passive-connection coroutines.
132 def cmd_passive(*args):
134 passive [OPTIONS] USER: Await the arrival of the named USER.
136 Report a challenge; when (and if!) the server receives a greeting quoting
137 this challenge, add the corresponding peer to the server.
140 op = T.OptParse(args, ['-timeout'])
142 if opt == '-timeout':
143 timeout = T.timespec(op.arg())
144 user, = op.rest(1, 1)
146 peer = CDB.init(opts.cdb)['U' + user]
148 raise T.TripeJobError('unknown-user', user)
150 cr = T.Coroutine.getcurrent()
151 timer = M.SelTimer(time() + timeout, lambda: cr.switch(None))
155 addr = cr.parent.switch()
157 raise T.TripeJobError('connect-timeout')
158 addpeer(Peer(peer), addr)
162 def notify(_, code, *rest):
164 Watch for notifications.
166 In particular, if a GREETing appears quoting a challenge in the chalmap
167 then wake up the corresponding coroutine.
174 chalmap[chal].switch(addr)
176 ###--------------------------------------------------------------------------
183 Register the notification-watcher, and add the automatic active peers.
185 S.handler['NOTE'] = notify
188 cdb = CDB.init(opts.cdb)
193 for name in M.split(autos)[0]:
195 peer = Peer(name, cdb)
196 addpeer(peer, M.split(peer.get('peer'), quotep = True)[0])
197 except T.TripeJobError, err:
198 S.warn('connect', 'auto-add-failed', name, *err.args)
202 Parse the command-line options.
204 Automatically changes directory to the requested configdir, and turns on
205 debugging. Returns the options object.
207 op = OptionParser(usage = '%prog [-a FILE] [-d DIR]',
208 version = '%%prog %s' % VERSION)
210 op.add_option('-a', '--admin-socket',
211 metavar = 'FILE', dest = 'tripesock', default = T.tripesock,
212 help = 'Select socket to connect to [default %default]')
213 op.add_option('-d', '--directory',
214 metavar = 'DIR', dest = 'dir', default = T.configdir,
215 help = 'Select current diretory [default %default]')
216 op.add_option('-p', '--peerdb',
217 metavar = 'FILE', dest = 'cdb', default = T.peerdb,
218 help = 'Select peers database [default %default]')
219 op.add_option('--daemon', dest = 'daemon',
220 default = False, action = 'store_true',
221 help = 'Become a daemon after successful initialization')
222 op.add_option('--debug', dest = 'debug',
223 default = False, action = 'store_true',
224 help = 'Emit debugging trace information')
225 op.add_option('--startup', dest = 'startup',
226 default = False, action = 'store_true',
227 help = 'Being called as part of the server startup')
229 opts, args = op.parse_args()
230 if args: op.error('no arguments permitted')
232 T._debug = opts.debug
235 ## Service table, for running manually.
236 service_info = [('connect', VERSION, {
237 'passive': (1, None, '[OPTIONS] USER', cmd_passive),
238 'active': (1, 1, 'PEER', cmd_active),
239 'info': (1, 1, 'PEER', cmd_info),
240 'list': (0, 0, '', cmd_list)
243 if __name__ == '__main__':
244 opts = parse_options()
245 T.runservices(opts.tripesock, service_info,
247 daemon = opts.daemon)
249 ###----- That's all, folks --------------------------------------------------