bases-devel Mailing List for Bases: Enterprise Application Framework (Page 2)

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 7
          http://bases.svn.sourceforge.net/bases/?rev=7&view=rev
Author:   joe_steeve
Date:     2009-02-26 07:09:40 +0000 (Thu, 26 Feb 2009)

Log Message:
-----------
Generalized the creation of bases-transport objects.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/TODO
    trunk/bases/core/broker.py
    trunk/bases/core/transports/transports.py
    trunk/src/bases-server
    trunk/src/server.ini

Modified: trunk/ChangeLog
===================================================================

--- trunk/ChangeLog	2009-02-26 07:06:33 UTC (rev 6)
+++ trunk/ChangeLog	2009-02-26 07:09:40 UTC (rev 7)
@@ -1,5 +1,23 @@
+2008-01-23  Joe Steeve  <joe...@gm...>
+
+	* src/bases-server (sanitizeConfigOptions): convert config option
+	types, put sane defaults, and basic option verification.
+	Removed unnecessary casts and exception handling
+	stuff. sanitizeConfigOptions makes them un-necessary
+
+	* bases/core/transports/transports.py (makeSSLContext): creation
+	of ssl context is needed in the broker. So, makes sense here.
+	This now uses twisted.internet.ssl.CertificateOptions to create a
+	context.
+
 2008-01-22  Joe Steeve  <joe...@gm...>
 
+	* bases/core/transports/transports.py (basesTransportsMap): add
+	this map to keep track for the protocols that we support
+
+	* src/bases-server (start_services): made protocol-factory
+	creation generic
+
 	* bases/services/directory.py (BasesComponentDirectory.__init__):
 	the component dir registers with the obj-repo.
 

Modified: trunk/TODO
===================================================================
--- trunk/TODO	2009-02-26 07:06:33 UTC (rev 6)
+++ trunk/TODO	2009-02-26 07:09:40 UTC (rev 7)
@@ -1,7 +1,7 @@
 
 * Broker related stuff
-- The MsgId should be a tuple = (id(broker), timestamp, number)
 
+
 * Things to verify
 
 - Does the logger rotate the logs?

Modified: trunk/bases/core/broker.py
===================================================================
--- trunk/bases/core/broker.py	2009-02-26 07:06:33 UTC (rev 6)
+++ trunk/bases/core/broker.py	2009-02-26 07:09:40 UTC (rev 7)
@@ -3,8 +3,11 @@
 This handles messages sent to remote bases-components. It keeps track
 of sent messages, and acts on obtaining a response."""
 
+from datetime import datetime
+
 from twisted.internet import defer, error, protocol
-from datetime import datetime
+from bases.core.transports import transports
+
 shafunc = None
 try:
 	import hashlib
@@ -100,11 +103,6 @@
 	ResponseObject: The object that was returned as a response.
 	"""
 
-	transports={}
-	in_method_calls={} # list of tuples of (location, msgid, time-stamp)
-	out_method_calls={} # list of tuples of (location, msgid,
-                        # time-stamp, deferred)
-
 	def __init__(self):
 		self.in_MethodCalls = {}
 		self.out_MethodCalls = {}
@@ -225,8 +223,8 @@
 		# Book-keeping
 		self.out_MethodCalls[MsgID] = (d, datetime.utcnow())
 		if not self.out_Transports.has_key(id(t)):
-			self.out_Transports[id(t)] = []
-		self.out_Transports[id(t)].append(MsgID)
+			self.out_Transports[id(t)] = {"trans":t, "msgs":[]}
+		self.out_Transports[id(t)]['msgs'].append(MsgID)
 		return d
 
 	
@@ -252,7 +250,7 @@
 			mref[0].Callback(dmesg[BASES_MSG_RESPONSE])
 		finally:
 			del(self.out_MethodCalls[dmesg[BASES_MSG_MSGID]])
-			self.out_Transports[id(trans)].remove(dmesg[BASES_MSG_MSGID])
+			self.out_Transports[id(trans)]['msgs'].remove(dmesg[BASES_MSG_MSGID])
 
 	
 	def getTransport(self, LocationTuple):
@@ -261,20 +259,22 @@
 		@param LocationTuple: A tuple in the following format
 		(protocol, host/ip, port)
 
-		@rtype: A BasesTransport object that implements the
-		IBasesTransport interface.
-
-		@return: An instance of the appropriate BasesTransport object
-		that should be used to connect to the location mentioned in
-		'LocationTuple'. If there is an existing connection, then that
-		object is returned.
+		@rtype: A BasesTransport object that can talk to the given
+		location. If there is an existing connection, then that object
+		is returned.
 		"""
-		if self.transports.has_key(LocationTuple):
-			return transports[LocationTuple]
-		else:
-			raise BasesNotImplemented, "TBD:obtaining a transport automagically"
+		for tid in self.out_Transports:
+			if self.out_Transports[tid]['trans'].canHandle(LocationTuple):
+				return self.out_Transports[tid]['trans']
 
+		secure = False
+		tmap = transports.basesTransportsMap
+		if LocationTuple[0] in tmap['secure']:
+			secure = True
+			
 
+		
+
 	def cleanupTransReferences(self, trans, server=False):
 		"""
 		I should be called when a transport is dying to clear out its

Modified: trunk/bases/core/transports/transports.py
===================================================================
--- trunk/bases/core/transports/transports.py	2009-02-26 07:06:33 UTC (rev 6)
+++ trunk/bases/core/transports/transports.py	2009-02-26 07:09:40 UTC (rev 7)
@@ -2,6 +2,9 @@
 from twisted.internet import protocol
 from twisted.python import log
 
+class BasesTransportError(Exception):
+	pass
+
 class _BasesServerFactory(protocol.ServerFactory):
 	def __init__(self, sname, broker, poser, Debug=False):
 		self.basesService = sname
@@ -23,3 +26,63 @@
 		log.msg(3, str(reason))
 		self.factory.basesBroker.cleanupTransReferences(self,
 														server=self._ServerSide)
+
+	def canHandle(self, LocationTuple):
+		"""
+		I check whether I can handle data for the given LocationTuple
+		and return a boolean True if I can. Else, I return a False.
+		"""
+		pass
+
+
+def makeSSLContext(Key, Cert, verify=False, CA=None):
+	'''Returns an ssl Context Object
+
+	@param Key: A X509 formatted key-file contents
+
+	@param Cert: A X509 formatted cert-file contents
+
+	@param verify: A boolean. Set this to True and provide the CA list
+	to verify the other side.
+	
+	@param CA: List of CAs that we trust.
+	'''
+
+	if verify == True and CA == None:
+		raise BasesTransportError("Cannot verify without CA")
+	
+	# our goal in here is to make a SSLContext object to pass to
+	# connectSSL or listenSSL
+	from twisted.internet import ssl
+	fctx = ssl.CertificateOptions(privateKey=Key,
+								  certificate=Cert,
+								  method=ssl.SSL.TLSv1_METHOD,
+								  verify=verify,
+								  caCerts=CA,
+								  verifyDepth=1,
+								  requireCertificate=True,
+								  verifyOnce=True,
+								  enableSingleUseKeys=True,
+								  enableSessions=True,
+								  fixBrokerPeers=True)
+	ctx = fctx.getContext()
+	return ctx
+
+
+def createBBTransServerFactory(*args, **kwargs):
+	from bases.core.transports import bbtrans
+	return bbtrans.BBTransServerFactory(*args, **kwargs)
+
+def createBBTransClientFactory(*args, **kwargs):
+	from bases.core.transports import bbtrans
+	return bbtrans.BBTransClientFactory(*args, **kwargs)
+
+
+basesTransportsMap = \
+				   {"server": \
+					{"bbtrans": createBBTransServerFactory},
+					"client": \
+					{"bbtrans": createBBTransClientFactory},
+					"secure": \
+					{"sbbtrans":"bbtrans"}
+					}

Modified: trunk/src/bases-server
===================================================================
--- trunk/src/bases-server	2009-02-26 07:06:33 UTC (rev 6)
+++ trunk/src/bases-server	2009-02-26 07:09:40 UTC (rev 7)
@@ -55,30 +55,23 @@
 		parser.error("ERROR: Not enough arguments (expected atleast 2)")
 		sys.exit(1)
 
-	#TBD: setup sane defaults for config file
 	conf = LoadConfig(args[0])
-	if not conf.has_key("globals.name"):
-		conf['globals.name'] = 'bases-server'
-		
+	conf = sanitizeConfigOptions(conf)
+
+	## Commandline options override the config file options.
 	# Setup verbosity
-	if not conf.has_key('globals.verbosity'):
-		conf['globals.verbosity'] = 0
-	else:
-		conf['globals.verbosity'] = int(conf['globals.verbosity'])
 	if options.verbosity > 0:
 		conf["globals.verbosity"] = options.verbosity
-	
 	# Foreground/Background
 	conf["globals.debug"] = options.debug
 	# Profiler?
 	conf["globals.profile_hs"] = options.profile_hs
 	if options.profile_hs is True:
 		if options.profile_file == "":
-			parser.error("ERROR: Please provide a file to log the profiler output")
+			parser.error("ERROR: Profile log file not given (--profile-log)")
 			sys.exit(1)
 		else:
 			conf["globals.profile_file"] = options.profile_file
-			
 	# explicitly deleting the parser
 	del(parser)
 	return conf, args
@@ -114,6 +107,90 @@
 	return conf
 
 
+def sanitizeConfigOptions(conf):
+	"""
+	The config parser loads the configuration file into conf as
+	strings. I sanitize the conf into the correct types as expected
+	everywhere in the code. In the process I also make sure some
+	essential options are not ommitted and provide sane defaults where
+	ever I can.
+	"""
+
+	# There should be better ways of doing this. But, for now this is
+	# enough.
+
+	# First make sure we have the essentials
+	try:
+		conf['globals.userid'] = int(conf['globals.userid'])
+		conf['globals.groupid'] = int(conf['globals.groupid'])
+		conf['globals.pidfile'] = conf['globals.pidfile']
+		conf['globals.bases_neighbours'] = conf['globals.bases_neighbours']
+		conf['globals.bases_cache'] = conf['globals.bases_cache']
+		conf['services'] = conf['services']
+	except KeyError, e:
+		print "Required option %s not found in config file" % (str(e))
+		sys.exit(1)
+
+	if conf.has_key('globals.verbosity'):
+		conf['globals.verbosity'] = int(conf['globals.verbosity'])
+	else:
+		conf['globals.verbosity'] = 0
+
+	if conf.has_key('globals.log_keep_days'):
+		conf['globals.log_keep_days'] = int(conf['globals.log_keep_days'])
+	else:
+		conf['globals.log_keep_days'] = 10
+
+	if not conf.has_key("globals.name"):
+		conf['globals.name'] = 'bases-server'
+
+	if not conf.has_key("globals.syslog_prefix"):
+		conf['globals.syslog_prefix'] = conf['globals.name']
+		
+	if len(conf['services']) == 0:
+		print "ERROR: No services defined"
+		sys.exit(1)
+
+	from bases.core.transports import transports
+	tmap = transports.basesTransportsMap
+	trans_list = tmap['server']
+	strans_list = tmap['secure']
+	
+	for s in conf['services']:
+		sn = s[0]
+		sd = s[1]
+		try:
+			sd['protocol'] = sd['protocol']
+			sd['interface'] = sd['interface']
+			sd['port'] = int(sd['port'])
+			sd['interface_repo'] = sd['interface_repo']
+		except KeyError, e:
+			print "Service=%s, Required option %s not defined" % (sn, str(e))
+			sys.exit(1)
+
+		if sd['protocol'] not in trans_list and \
+		   sd['protocol'] not in strans_list:
+			print "Service:%s,Protocol=%s is not known" % \
+				  (sn, sd['protocol'])
+			sys.exit(1)
+
+		if sd['protocol'] in strans_list:
+			if not sd.has_key('sslkey') or \
+			   not sd.has_key('sslcert'):
+				print "Service:%s,Protocol=%s requires sslkey and sslcert" % \
+					  (sn, sd['protocol'])
+				sys.exit(1)
+			if sd.has_key('verify_peers'):
+				sd['verify_peers'] = bool(sd['verify_peers'])
+			else:
+				sd['verify_peers'] = False
+			if sd['verify_peers'] is True and not sd.has_key('ca'):
+				print "Service=%s,Protocol=%s requires CA to verify_peers" % \
+					  (sn, sd['protocol'])
+				sys.exit(1)
+	return conf
+
+
 def start_server(conf):
 	"""
 	I start the bases-server. I setup the server based on the given
@@ -130,8 +207,7 @@
 	from twisted.internet import reactor	
 	start_services(conf, reactor)
 	try:
-		util.switchUID(int(conf['globals.userid']),
-					   int(conf['globals.groupid']))
+		util.switchUID(conf['globals.userid'], conf['globals.groupid'])
 	except:
 		pass
 	
@@ -185,9 +261,8 @@
 	day.
 
 	If globals.debug is not set and globals.log is not set, then I
-	setup logging to syslog. When logging to syslog, I look for the
-	optional globals.syslog_prefix option and use it as a program
-	prefix in the syslog instead of the string 'bases-server'.
+	setup logging to syslog. When logging to syslog, I use
+	globals.syslog_prefix as a program prefix.
 	"""
 	
 	if conf["globals.debug"] is True:
@@ -212,10 +287,7 @@
 			log.startLoggingWithObserver(lo.emit, setStdout=True)
 		else:
 			lo = None
-			if conf.has_key("globals.syslog_prefix"):
-				lo = BasesSysLogObserver(conf['globals.syslog_prefix'])
-			else:
-				lo = BasesSysLogObserver("bases-server")
+			lo = BasesSysLogObserver(conf['globals.syslog_prefix'])
 			lo.bases_verbosity = conf['globals.verbosity']				
 			log.startLoggingWithObserver(lo.emit, setStdout=True)
 
@@ -228,23 +300,18 @@
 	if conf['globals.debug'] is True:
 		return
 
-	# Check if we have a pidfile and whether we can write to it
-	if conf.has_key("globals.pidfile"):
-		d = os.path.dirname(conf["globals.pidfile"])
-		if not os.access(d, os.W_OK):
-			stderr.write("ERROR: need write permissions on pidfile directory")
-			stderr.flush()			
-			sys.exit(1)
-		if (os.access(conf["globals.pidfile"], os.F_OK) is True) and \
-			   (os.access(conf["globals.pidfile"], os.W_OK) is False):
-			stderr.write("ERROR: unable to write to pid file (%s)" % \
-						 (conf["globals.pidfile"]))
-			stderr.flush()			
-			sys.exit(1)
-	else:
-		stderr.write("ERROR: no pidfile given in %s" % (conf['config_file']))
-		stderr.flush()		
+	# Check whether we can write to the globals.pidfile
+	d = os.path.dirname(conf["globals.pidfile"])
+	if not os.access(d, os.W_OK):
+		stderr.write("ERROR: need write permissions on pidfile directory")
+		stderr.flush()			
 		sys.exit(1)
+	if os.access(conf["globals.pidfile"], os.F_OK) is True and \
+	   os.access(conf["globals.pidfile"], os.W_OK) is False:
+		stderr.write("ERROR: unable to write to pid file (%s)" % \
+					 (conf["globals.pidfile"]))
+		stderr.flush()			
+		sys.exit(1)
 
 	# Fork #1
 	pid = 0
@@ -282,11 +349,9 @@
 	I iterate through the defined services and configure a listener on
 	each of them..
 	"""
-	if len(conf['services']) == 0:
-		print "ERROR: No services defined"
-		sys.exit(0)
-
 	from bases.services import objrepo, directory
+	from bases.core.transports import transports
+	tmap = transports.basesTransportsMap
 
 	b = broker.BasesBroker()
 	p = broker.BasesAsyncPoser()
@@ -296,92 +361,42 @@
 	for s in conf["services"]:
 		sname = s[0]
 		desc = s[1]
-		if desc['protocol'] == "sbbtrans":
-			start_sbbtrans(reactor, conf, desc, sname, b, p)
-		elif desc['protocol'] == "bbtrans":
-			start_bbtrans(reactor, conf, desc, sname, b, p)
-		else:
-			print "ERROR: Unimplemented protocol %s" % (desc['protocol'])
-			sys.exit(1)
-	return
+		secure = False
+		proto = desc['protocol']
+		ctxt = None
 
-			
-def start_sbbtrans(reactor, conf, desc, sname, broker, poser):
-	ctx = makeSSLContext(desc['sslkey'], desc['sslcert'], desc['ca'])
-	from bases.core.transports import bbtrans
-	f = bbtrans.BBTransServerFactory(sname, broker, poser,
-									 Debug=conf['globals.debug'])
-	reactor.listenSSL(int(desc['port']), f, ctx)
+		# Check whether the given protocol is one of the secure
+		# protocols. i.e. requires Digital Certificate
+		# verification
+		if proto in tmap['secure']:
+			secure = True
 
+			# Read the key, certificate and CA stuff
+			fd = open(desc['sslkey'],'r')
+			key_buff = fd.read()
+			fd.close()
+			fd = open(desc['sslcert'],'r')
+			cert_buff = fd.read()
+			fd.close()
+			ca_buff = None
+			if desc['verify_peer'] is True:
+				fd = open(desc['ca'],'r')
+				ca_buff = fd.read()
+				fd.close()
 
-def start_bbtrans(reactor, conf, desc, sname, broker, poser):
-	from bases.core.transports import bbtrans
-	f = bbtrans.BBTransServerFactory(sname, broker, poser,
-									 Debug=conf['globals.debug'])
-	reactor.listenTCP(int(desc['port']), f)
+			ctxt = transports.makeSSLContext(key_buff, cert_buff,
+											 verify=desc['verify_peer'],
+											 CA=ca_buff)
+			proto = tmap['secure'][proto]
 
+		ffactory = tmap['server'][proto]
+		f = ffactory(sname, b, p, Debug=conf['globals.debug'])
+		if secure is True:
+			reactor.listenSSL(desc['port'], f, ctxt)			
+		else:
+			reactor.listenTCP(desc['port'], f)
 
-def makeSSLContext(Key, CA):
-	'''Returns an ssl Context Object
 
-	@param myKey a pem formated key and certifcate with for my current
-		host the other end of this connection must have the cert
-		from the CA that signed this key
-
-	@param trustedCA a pem formated certificat from a CA you trust you
-		will only allow connections from clients signed by this CA
-		and you will only allow connections to a server signed by
-		this CA
-	'''
-
-	# our goal in here is to make a SSLContext object to pass to
-	# connectSSL or listenSSL
-
-	# Why these functioins... Not sure...
-	fd = open(Key,'r')
-	theCert = ssl.PrivateCertificate.loadPEM(fd.read())
-	fd.close()
-	fd = open(CA,'r')
-	theCA = ssl.Certificate.loadPEM(fd.read())
-	fd.close()
-	ctx = theCert.options(theCA)
-
-	# Now the options you can set look like Standard OpenSSL Library
-	# options
-
-	# The SSL protocol to use, one of SSLv23_METHOD, SSLv2_METHOD,
-	# SSLv3_METHOD, TLSv1_METHOD. Defaults to TLSv1_METHOD.
-	ctx.method = ssl.SSL.TLSv1_METHOD
-
-	# If True, verify certificates received from the peer and fail the
-	# handshake if verification fails. Otherwise, allow anonymous
-	# sessions and sessions with certificates which fail validation.
-	ctx.verify = True
-
-	# Depth in certificate chain down to which to verify.
-	ctx.verifyDepth = 1
-	
-	# If True, do not allow anonymous sessions.
-	ctx.requireCertification = True
-	
-	# If True, do not re-verify the certificate on session resumption.
-	ctx.verifyOnce = True
-	
-	# If True, generate a new key whenever ephemeral DH parameters are
-	# used to prevent small subgroup attacks.
-	ctx.enableSingleUseKeys = True
-
-	# If True, set a session ID on each context. This allows a
-	# shortened handshake to be used when a known client reconnects.
-	ctx.enableSessions = True
-
-	# If True, enable various non-spec protocol fixes for broken SSL
-	# implementations.
-	ctx.fixBrokenPeers = False
-
-	return ctx
-
-
 ## Lifted off twisted's code
 def runWithHotshot(conf, reactor):
 	"""Run reactor under hotshot profiler."""

Modified: trunk/src/server.ini
===================================================================
--- trunk/src/server.ini	2009-02-26 07:06:33 UTC (rev 6)
+++ trunk/src/server.ini	2009-02-26 07:09:40 UTC (rev 7)
@@ -49,6 +49,7 @@
 port=10001
 
 # SSL options
+verify_peers=True
 ca=/etc/bases-server/CA.pem
 sslkey=/etc/bases-server/bases-SSL.key
 sslcert=/etc/bases-server/bases-SSL.crt


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




bases-devel Mailing List for Bases: Enterprise Application Framework (Page 2)

bases-devel — Developer mailing list