<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[13074] CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/13074">13074</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2014-03-31 18:03:36 -0700 (Mon, 31 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Use twext.who instead of OD module.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServerbranchesuserssagenmove2who4calendarservertoolsagentpy">CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools/agent.py</a></li>
<li><a href="#CalendarServerbranchesuserssagenmove2who4calendarservertoolstesttest_agentpy">CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools/test/test_agent.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServerbranchesuserssagenmove2who4calendarservertoolsagentpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools/agent.py (13073 => 13074)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools/agent.py 2014-04-01 00:58:20 UTC (rev 13073)
+++ CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools/agent.py 2014-04-01 01:03:36 UTC (rev 13074)
</span><span class="lines">@@ -26,130 +26,38 @@
</span><span class="cx">
</span><span class="cx"> from __future__ import print_function
</span><span class="cx">
</span><ins>+__all__ = [
+ "makeAgentService",
+]
+
</ins><span class="cx"> import cStringIO
</span><ins>+from plistlib import readPlistFromString, writePlistToString
</ins><span class="cx"> import socket
</span><span class="cx">
</span><span class="cx"> from calendarserver.tap.util import getRootResource
</span><del>-from plistlib import readPlistFromString, writePlistToString
</del><ins>+from twext.python.launchd import getLaunchDSocketFDs
+from twext.python.log import Logger
+from twext.who.checker import HTTPDigestCredentialChecker
+from twext.who.opendirectory import (
+ DirectoryService as OpenDirectoryDirectoryService,
+ NoQOPDigestCredentialFactory
+)
</ins><span class="cx"> from twisted.application.internet import StreamServerEndpointService
</span><del>-from twisted.cred.checkers import ICredentialsChecker
-from twisted.cred.credentials import IUsernameHashedPassword
-from twisted.cred.error import UnauthorizedLogin
</del><span class="cx"> from twisted.cred.portal import IRealm, Portal
</span><del>-from twisted.internet.defer import inlineCallbacks, returnValue, succeed, fail
</del><ins>+from twisted.internet.defer import inlineCallbacks, returnValue
</ins><span class="cx"> from twisted.internet.endpoints import AdoptedStreamServerEndpoint
</span><span class="cx"> from twisted.internet.protocol import Factory
</span><span class="cx"> from twisted.protocols import amp
</span><del>-from twisted.web.guard import HTTPAuthSessionWrapper, DigestCredentialFactory
</del><ins>+from twisted.web.guard import HTTPAuthSessionWrapper
</ins><span class="cx"> from twisted.web.resource import IResource, Resource, ForbiddenResource
</span><span class="cx"> from twisted.web.server import Site, NOT_DONE_YET
</span><span class="cx"> from zope.interface import implements
</span><del>-from twext.python.launchd import getLaunchDSocketFDs
-from twext.python.log import Logger
</del><span class="cx">
</span><ins>+
</ins><span class="cx"> log = Logger()
</span><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><del>-class DirectoryServiceChecker(object):
- """
- A checker that knows how to ask OpenDirectory to authenticate via Digest
- """
- implements(ICredentialsChecker)
-
- credentialInterfaces = (IUsernameHashedPassword,)
-
- from calendarserver.platform.darwin.od import opendirectory
- directoryModule = opendirectory
-
- def __init__(self, node):
- """
- @param node: the name of the OpenDirectory node to use, e.g.
- C{"/Local/Default"}
- """
- self.node = node
- self.directory = self.directoryModule.odInit(node)
-
-
- def requestAvatarId(self, credentials):
- record = self.directoryModule.getUserRecord(
- self.directory, credentials.username
- )
-
- if record is not None:
- try:
- if "algorithm" not in credentials.fields:
- credentials.fields["algorithm"] = "md5"
-
- challenge = (
- 'Digest realm="{realm}", nonce="{nonce}", '
- 'algorithm={algorithm}'
- .format(**credentials.fields)
- )
-
- response = (
- 'Digest username="{username}", '
- 'realm="{realm}", '
- 'nonce="{nonce}", '
- 'uri="{uri}", '
- 'response="{response}",'
- 'algorithm={algorithm}'
- ).format(**credentials.fields)
-
- except KeyError as e:
- log.error(
- "OpenDirectory (node={checker.node}) error while "
- "performing digest authentication for user "
- "{credentials.username}: missing digest response field: "
- "{field} in: {credentials.fields}"
- .format(
- checker=self, credentials=credentials, field=e
- )
- )
- return fail(UnauthorizedLogin())
-
- try:
- if self.directoryModule.authenticateUserDigest(
- self.directory,
- self.node,
- credentials.username,
- challenge,
- response,
- credentials.method
- ):
- return succeed(credentials.username)
- else:
- log.error(
- "Failed digest auth with response: {response}",
- response=response
- )
- return fail(UnauthorizedLogin())
- except Exception as e:
- log.error(
- "OpenDirectory error while performing digest "
- "authentication for user {credentials.username}: "
- "{error}",
- credentials=credentials, error=e
- )
- return fail(UnauthorizedLogin())
-
- else:
- return fail(UnauthorizedLogin())
-
-
-
-class CustomDigestCredentialFactory(DigestCredentialFactory):
- """
- DigestCredentialFactory without qop, to interop with OD.
- """
-
- def getChallenge(self, address):
- result = DigestCredentialFactory.getChallenge(self, address)
- del result["qop"]
- return result
-
-
-
</del><span class="cx"> class AgentRealm(object):
</span><span class="cx"> """
</span><span class="cx"> Only allow a specified list of avatar IDs to access the site
</span><span class="lines">@@ -277,12 +185,15 @@
</span><span class="cx"> )
</span><span class="cx"> )
</span><span class="cx">
</span><del>- realmName = "/Local/Default"
</del><ins>+ directory = OpenDirectoryDirectoryService("/Local/Default")
+
</ins><span class="cx"> portal = Portal(
</span><span class="cx"> AgentRealm(root, ["com.apple.calendarserver"]),
</span><del>- [DirectoryServiceChecker(realmName)]
</del><ins>+ [HTTPDigestCredentialChecker(directory)]
</ins><span class="cx"> )
</span><del>- credentialFactory = CustomDigestCredentialFactory("md5", realmName)
</del><ins>+ credentialFactory = NoQOPDigestCredentialFactory(
+ "md5", "CalendarServer Agent Realm"
+ )
</ins><span class="cx"> wrapper = HTTPAuthSessionWrapper(portal, [credentialFactory])
</span><span class="cx">
</span><span class="cx"> site = Site(wrapper)
</span></span></pre></div>
<a id="CalendarServerbranchesuserssagenmove2who4calendarservertoolstesttest_agentpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools/test/test_agent.py (13073 => 13074)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools/test/test_agent.py 2014-04-01 00:58:20 UTC (rev 13073)
+++ CalendarServer/branches/users/sagen/move2who-4/calendarserver/tools/test/test_agent.py 2014-04-01 01:03:36 UTC (rev 13074)
</span><span class="lines">@@ -16,84 +16,18 @@
</span><span class="cx">
</span><span class="cx"> try:
</span><span class="cx"> from calendarserver.tools.agent import AgentRealm
</span><del>- from calendarserver.tools.agent import CustomDigestCredentialFactory
- from calendarserver.tools.agent import DirectoryServiceChecker
</del><span class="cx"> from calendarserver.tools.agent import InactivityDetector
</span><span class="cx"> from twistedcaldav.test.util import TestCase
</span><del>- from twisted.internet.defer import inlineCallbacks
</del><span class="cx"> from twisted.internet.task import Clock
</span><del>- from twisted.cred.error import UnauthorizedLogin
</del><span class="cx"> from twisted.web.resource import IResource
</span><span class="cx"> from twisted.web.resource import ForbiddenResource
</span><del>- RUN_TESTS = True
</del><ins>+
</ins><span class="cx"> except ImportError:
</span><del>- RUN_TESTS = False
</del><ins>+ pass
</ins><span class="cx">
</span><del>-
-
-if RUN_TESTS:
</del><ins>+else:
</ins><span class="cx"> class AgentTestCase(TestCase):
</span><span class="cx">
</span><del>- def test_CustomDigestCredentialFactory(self):
- f = CustomDigestCredentialFactory("md5", "/Local/Default")
- challenge = f.getChallenge(FakeRequest())
- self.assertTrue("qop" not in challenge)
- self.assertEquals(challenge["algorithm"], "md5")
- self.assertEquals(challenge["realm"], "/Local/Default")
-
- @inlineCallbacks
- def test_DirectoryServiceChecker(self):
- c = DirectoryServiceChecker("/Local/Default")
- fakeOpenDirectory = FakeOpenDirectory()
- c.directoryModule = fakeOpenDirectory
-
- fields = {
- "username": "foo",
- "realm": "/Local/Default",
- "nonce": 1,
- "uri": "/gateway",
- "response": "abc",
- "algorithm": "md5",
- }
- creds = FakeCredentials("foo", fields)
-
- # Record does not exist:
- fakeOpenDirectory.returnThisRecord(None)
- try:
- yield c.requestAvatarId(creds)
- except UnauthorizedLogin:
- pass
- else:
- self.fail("Didn't raise UnauthorizedLogin")
-
- # Record exists, but invalid credentials
- fakeOpenDirectory.returnThisRecord("fooRecord")
- fakeOpenDirectory.returnThisAuthResponse(False)
- try:
- yield c.requestAvatarId(creds)
- except UnauthorizedLogin:
- pass
- else:
- self.fail("Didn't raise UnauthorizedLogin")
-
- # Record exists, valid credentials
- fakeOpenDirectory.returnThisRecord("fooRecord")
- fakeOpenDirectory.returnThisAuthResponse(True)
- avatar = (yield c.requestAvatarId(creds))
- self.assertEquals(avatar, "foo")
-
- # Record exists, but missing fields in credentials
- del creds.fields["nonce"]
- fakeOpenDirectory.returnThisRecord("fooRecord")
- fakeOpenDirectory.returnThisAuthResponse(False)
- try:
- yield c.requestAvatarId(creds)
- except UnauthorizedLogin:
- pass
- else:
- self.fail("Didn't raise UnauthorizedLogin")
-
-
</del><span class="cx"> def test_AgentRealm(self):
</span><span class="cx"> realm = AgentRealm("root", ["abc"])
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>