← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« 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-04 18:51:39 UTC
  • mfrom: (2961.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20071104185139-kaio3sneodg2kp71
Authentication ring implementation (read-only)

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
 
108
108
 
109
109
 
110
110
File format
111
 
-----------
 
111
===========
112
112
 
113
113
The general rules for `configuration files`_ apply except for the variable
114
114
policies.
115
115
 
116
 
.. _configuration files: #configuration-settings
 
116
.. _configuration files: configuration.html
117
117
 
118
118
Each section describes an authentication definition.
119
119
 
136
136
 
137
137
 
138
138
Examples
139
 
--------
 
139
========
140
140
 
141
141
 
142
142
Personal projects hosted outside
143
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
143
--------------------------------
144
144
 
145
145
All connections are done with the same ``user`` (the remote one for which the
146
146
default bzr one is not appropriate) and the password is always prompted with
165
165
 
166
166
 
167
167
Source hosting provider
168
 
~~~~~~~~~~~~~~~~~~~~~~~
 
168
-----------------------
169
169
 
170
170
In the shp.net (fictious) domain, each project has its own site::
171
171
 
175
175
        # The leading '.' ensures that 'shp.net' alone doesn't match
176
176
        host=.shp.net
177
177
        user=joe
178
 
        # bzr don't support supplying a password for sftp,
179
 
        # consider using an ssh agent if you don't want to supply
180
 
        # a password interactively. (pageant, ssh-agent, etc)
 
178
        password=precious
181
179
 
182
180
HTTPS, SFTP servers and their proxy
183
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
181
-----------------------------------
184
182
 
185
 
At company.com, the server hosting release and integration branches is behind a
186
 
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::
187
185
 
188
186
        [reference code]
189
187
        scheme=https
198
196
        host=dev.company.com
199
197
        path=/dev/integration
200
198
        user=user2
 
199
        password=pass2
201
200
        
202
201
        # proxy
203
202
        [proxy]
209
208
 
210
209
 
211
210
Planned enhancements
212
 
--------------------
 
211
====================
213
212
 
214
213
The following are not yet implemented but planned as parts of a work in
215
214
progress:
225
224
* add a ``verify_certificates`` field for ``HTTPS``.
226
225
 
227
226
The ``password_encoding`` and ``verify_certificates`` fields are recognized but
228
 
ignored in the actual implementation.
 
227
ignored in the actual implementation.
 
 
b'\\ No newline at end of file'