Woven Guard Docs

[twisted-trac]

	@glyph reported
Trac ID	trac#55
Type	enhancement
Created	2003-07-13 04:11:11Z

Searchable metadata

trac-id__55 55
type__enhancement enhancement
reporter__glyph glyph
priority__normal normal
milestone__ 
branch__ 
branch_author__ 
status__closed closed
resolution__fixed fixed
component__ 
keywords__documentation_web documentation web
time__1058069471000000 1058069471000000
changetime__1076055962000000 1076055962000000
version__ 
owner__ 
cc__glyph cc__radix cc__itamarst cc__jml cc__pobrien cc__hypatia

[twisted-trac]

	@glyph commented

#!html
<pre>
"Guard In Depth" is empty, and this is bad.  The old-cred
stuff should be deprecated and the new-cred stuff explained
in detail.

</pre>

[twisted-trac]

	gravis commented

#!html
<pre>
here is an exemple provided by David McCurley on the ml.
http://article.gmane.org/gmane.comp.python.twisted/3870
I have not tested it yet, but it could help write the howto.

</pre>

[twisted-trac]

	@jml commented

#!html
<pre>
I've just committed some API docs for guard, based mainly on
the increased understand offered by dynademo. Probably worth
you double-checking, glyph.

BTW, UsernamePasswordWrapper is an atrocious name. What does
it wrap?

</pre>

[twisted-trac]

	@itamarst commented

#!html
<pre>
We need this for 1.1.
</pre>

[twisted-trac]

	@itamarst commented

#!html
<pre>
I've been looking at simpleguard, I've used guard's full capabilites, and I have
no idea how the hell it works or how to use it again next time, I'm going to
have to relearn it from scratch. The portal bit is clear, it's the interaction
with the login form I really don't get (and it doesn't help that I don't really
understand woven.form).
</pre>

[twisted-trac]

	@radix commented

#!html
<pre>
jml, UsernamePasswordWrapper wraps the UsernamePassword credential, which is
just one kind of credential that's possible (i.e., there are also things like
ssh keys, and so on). It creates a UsernamePassword from web input.
</pre>

[twisted-trac]

	@jml commented

#!html
<pre>
This may overly pedantic (or just wrong), but doesn't it wrap a Portal that has 
UsernamePassword-expecting checkers associated with it?
</pre>

[twisted-trac]

	@itamarst commented

#!html
<pre>
glyph has no time for this. any other volunteers are welcome (but I want 1.1 out
by the end of the week, so "maybe" don't cut it.)
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
Let me summarize how a guard doc should look like:

1. Write a realm which responds to IResource
2. Wrap it with guard.BlahblahWrapper(guard.BlahblahblahWrapper())
3. Feel free to use request.getSession, it is a Componentized
4. Use the resource (2) gave you wherever you want the guarded site
   should be.
5. You sure as hell want AllowAnonymousAccess in the checkers, because
   of the beautifully wonderful way HTTP works.

Just use more words :)
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
/cvs/Twisted/doc/howto/guardindepth.xhtml,v  &lt;--  guardindepth.xhtml
new revision: 1.2; previous revision: 1.1

Fixed.
</pre>

[twisted-trac]

	@itamarst commented

#!html
<pre>
I think it needs a lot more than that. It's a good start though.
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
What more does it need?
</pre>

[twisted-trac]

	@itamarst commented

#!html
<pre>
Examples of how to customize UI, explanation of the URL flow (redirection,
etc.), less vague explanations of what PESPECTIVE_XXX urls are, examples of how
to logout, etc.. Does it even mention that realms are supposed to return
resources? or why?
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
OK, I tried to add some stuff
1. Some sketchy description of the redirection loop
2. Actual code examples which show how to write appropriate realms

I don't know what you mean by "modifying UI". Assuming you mean modifying
the login form, I have nfi how to do it. If anyone has an example which
does it, I'll be happy to integrate it.
</pre>

[twisted-trac]

	@itamarst commented

#!html
<pre>
I added an example of customized login page, now it needs explanations of how it
works.
</pre>

[twisted-trac]

	@itamarst commented

#!html
<pre>
Also see sandbox/glyph/dynademo/ and the even mores sophisticated
sandbox/tv/dynademo/.
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
/cvs/Twisted/doc/howto/guardindepth.xhtml,v  &lt;--  guardindepth.xhtml
new revision: 1.9; previous revision: 1.8
/cvs/Twisted/doc/howto/listings/guard/login.py,v  &lt;--  login.py
new revision: 1.2; previous revision: 1.1

Added walk-through of the code, and simplified code. Noted that this
could have been done anyway with simpleguard, so I used that to
show off -- this way, most of the example lines deal with the relevant
stuff -- namely, the login page.
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
Can someone read the guard docs and comment?
The only reason I'm holding off on closing this is because I'm
not sure the docs make sense to someone who's != me.
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
I guess that qualifies as testing
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
I'm closing this now.
</pre>

[twisted-trac]

	@glyph commented

#!html
<pre>
Moshe Zadka [Twisted issue tracker] wrote:

> Can someone read the guard docs and comment?

They made sense to me.  I'd say they need work, but they're definitely 
good enough for 1.1.  We need users to comment as well.
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
Please explain what works "needs to be done".
</pre>

[twisted-trac]

	@itamarst commented

#!html
<pre>
Perhaps the more sophisticated stuff Tv is doing?
</pre>

[twisted-trac]

	@moshez commented

#!html
<pre>
I actually also have a more comprehensive example based on glyph's
dynademo.
Maybe the rest of the howto should be just "bunch of examples", because
we've already shown the basics -- somewhat like a cookbook approach.
Of course, much like simpleguard, eventually I'd like to see if there's
a way to replace the cookbook approach with a library approach :)
</pre>

[twisted-trac]

	@jyknight commented

#!html
<pre>
This bug is being resolved, wontfix, as woven is "almost deprecated" and unmaintained. Use nevow 
instead. See &lt;http://divmod.org/users/dp.twistd/wiki/> and the twisted-web mailing list &lt;http://
twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-web>.

Also, this bug sounds like it's been resolved in any case.
</pre>

[twisted-trac]

	Automation removed owner