~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/authentication-ring.txt

  • Committer: Vincent Ladeuil
  • Date: 2007-11-04 15:24:27 UTC
  • mto: (2961.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 2962.
  • Revision ID: v.ladeuil+lp@free.fr-20071104152427-p9k7e4toywa87wfc
Review feedback.

* doc/en/user-guide/authentication_conf.txt: 
New file. Authentication configuration file documentation.

* doc/en/user-guide/configuration.txt: 
Slight modifications, add authentication.conf reference.

* doc/en/mini-tutorial/index.txt: 
Fix make docs warning.

* doc/developers/authentication-ring.txt: 
Small cleanups noticed during
doc/en/user-guide/authentication_conf.txt redaction.

* bzrlib/transport/http/_urllib.py:
(HttpTransport_urllib._perform): Use a dict() instead of {} syntax.

* bzrlib/tests/blackbox/test_whoami.py:
(TestWhoami.test_whoami_branch): Delete BZREMAIL related tests.

* bzrlib/config.py:
(Config.username): BZREMAIL deleted, has been obsolete for more
than a year.
(AuthenticationConfig.__init__): Review feedback, since keeping a
callback as an attribute is useless, call it now and keep the
filename itself as an attribute.
(AuthenticationConfig.get_credentials): Use a dict() instead of {}
syntax.

* NEWS: 
Updated as per Martin's suggestion.

Show diffs side-by-side

added added

removed removed

Lines of Context:
70
70
Authentication definitions
71
71
--------------------------
72
72
 
73
 
There are two kinds of authentication used by the various schemes:
 
73
There are two kinds of authentication used by the various schemes supported by
 
74
bzr:
74
75
 
75
76
1. user and password
76
77
 
109
110
 
110
111
  * ``port`` can be empty (useful when an host provides several servers for the
111
112
    same scheme), only numerical values are allowed, this should be used only
112
 
    when the server use a port different than the scheme standard port,
 
113
    when the server uses a port different than the scheme standard port,
113
114
 
114
115
  * ``path``: can be empty (FTP or SFTP will never user it),
115
116
 
137
138
 3. ``scheme`` matches even if decorators are used in the requested URL,
138
139
 
139
140
 4. ``host`` matches exactly or act as a domain if it starts with '.'
140
 
   (``project.bzr.sf.net`` will match ``.bzr.sf.net`` but ``projectbzr.sf.net``
141
 
   will not match ``bzr.sf.net``).
 
141
    (``project.bzr.sf.net`` will match ``.bzr.sf.net`` but ``projectbzr.sf.net``
 
142
    will not match ``bzr.sf.net``).
142
143
 
143
144
 5. ``port`` matches if included in the requested URL (exact matches only)
144
145
 
188
189
``~/.bazaar/authentication.conf`` will use the same file format than
189
190
``~/.bazaar/bazaar.conf``.
190
191
 
191
 
Each section will define an authentication definition.
 
192
Each section describes an authentication definition.
192
193
 
193
194
The section name is an arbitrary string, only the ``DEFAULT`` value is reserved
194
195
and should appear as the *last* section.