/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/en/user-guide/authentication_conf.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-11-27 14:38:38 UTC
  • mfrom: (3009.2.29 no-inventory)
  • Revision ID: pqm@pqm.ubuntu.com-20071127143838-lkx79x6q91uptc1o
Avoid using Tree.inventory (even indirectly) from diff command

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/authentication_conf.txt
1
 
Authentication Settings
2
 
=======================
 
1
=================================
 
2
Authentication configuration file
 
3
=================================
3
4
 
4
5
 
5
6
Intent
6
 
------
 
7
======
7
8
 
8
9
Many different authentication policies can be described in the
9
 
``authentication.conf`` file but a particular user should need only a few
10
 
definitions to cover his needs without having to specify a user and a password
11
 
for every branch he uses.
 
10
``$HOME/.bazaar/authentication.conf`` file but a particular user should need
 
11
only a few definitions to cover his needs without having to specify a user and
 
12
a password for every branch he uses.
12
13
 
13
14
The definitions found in this file are used to find the credentials to use for
14
15
a given url. The same credentials can generally be used for as many branches as
40
41
  
41
42
 
42
43
Authentication definitions
43
 
--------------------------
 
44
==========================
44
45
 
45
46
There are two kinds of authentication used by the various schemes supported by
46
47
bzr:
47
48
 
48
49
1. user and password
49
50
 
50
 
``FTP`` needs a (``user``, ``password``) to authenticate against a ``host``
51
 
``SFTP`` can use either a password or a host key to authenticate. However,
52
 
ssh agents are a better, more secure solution. So we have chosen to not provide
53
 
our own less secure method.
 
51
``FTP`` and ``SFTP`` needs a (``user``, ``password``) to authenticate against a
 
52
``host`` (SFTP can use ssh keys too, but we don't talk about that here as ssh
 
53
agents provide a better solution).
54
54
 
55
55
2. user, realm and password
56
56
 
58
58
against a host. But, by using ``.htaccess`` files, for example, it is possible
59
59
to define several (``user, realm, password``) for a given ``host``. So what is
60
60
really needed is (``user``, ``password``, ``host``, ``path``). The ``realm`` is
61
 
not taken into account in the definitions, but will displayed if bzr prompts
62
 
you for a password.
 
61
not taken into account in the defitions, but will displayed if bzr prompts you
 
62
for a password.
63
63
 
64
 
``HTTP proxy`` can be handled as ``HTTP`` (or ``HTTPS``) by explicitly
 
64
``HTTP proxy`` can be handled as ``HTTP`` (or ``HTTPS``) by explicitely
65
65
specifying the appropriate port.
66
66
 
67
67
To take all schemes into account, the password will be deduced from a set of
108
108
 
109
109
 
110
110
File format
111
 
-----------
112
 
 
113
 
The general rules for :doc:`configuration files <configuration-help>`
114
 
apply except for the variable policies.
 
111
===========
 
112
 
 
113
The general rules for `configuration files`_ apply except for the variable
 
114
policies.
 
115
 
 
116
.. _configuration files: configuration.html
115
117
 
116
118
Each section describes an authentication definition.
117
119
 
134
136
 
135
137
 
136
138
Examples
137
 
--------
 
139
========
138
140
 
139
141
 
140
142
Personal projects hosted outside
141
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
143
--------------------------------
142
144
 
143
145
All connections are done with the same ``user`` (the remote one for which the
144
146
default bzr one is not appropriate) and the password is always prompted with
163
165
 
164
166
 
165
167
Source hosting provider
166
 
~~~~~~~~~~~~~~~~~~~~~~~
 
168
-----------------------
167
169
 
168
 
In the shp.net (fictitious) domain, each project has its own site::
 
170
In the shp.net (fictious) domain, each project has its own site::
169
171
 
170
172
        [shpnet domain]
171
173
        # we use sftp, but ssh is the scheme used for authentication
173
175
        # The leading '.' ensures that 'shp.net' alone doesn't match
174
176
        host=.shp.net
175
177
        user=joe
176
 
        # bzr don't support supplying a password for sftp,
177
 
        # consider using an ssh agent if you don't want to supply
178
 
        # a password interactively. (pageant, ssh-agent, etc)
 
178
        password=precious
179
179
 
180
180
HTTPS, SFTP servers and their proxy
181
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
181
-----------------------------------
182
182
 
183
 
At company.com, the server hosting release and integration branches is behind a
184
 
proxy, and the two branches use different authentication policies::
 
183
At company.com, the server hosting released and integration code is behind a
 
184
proxy, the two servers use different authentication policies::
185
185
 
186
186
        [reference code]
187
187
        scheme=https
196
196
        host=dev.company.com
197
197
        path=/dev/integration
198
198
        user=user2
 
199
        password=pass2
199
200
        
200
201
        # proxy
201
202
        [proxy]
207
208
 
208
209
 
209
210
Planned enhancements
210
 
--------------------
 
211
====================
211
212
 
212
213
The following are not yet implemented but planned as parts of a work in
213
214
progress:
223
224
* add a ``verify_certificates`` field for ``HTTPS``.
224
225
 
225
226
The ``password_encoding`` and ``verify_certificates`` fields are recognized but
226
 
ignored in the actual implementation.
 
227
ignored in the actual implementation.
 
 
b'\\ No newline at end of file'