This section provides information on the authentication settings that you can specify to log in to a Subversion repository.
Table: Subversion repository access protocols
|Direct repository access.|
|Access via custom protocol to the SVN server.|
|Same as |
|Access through a web server (usually Apache) |
with possible SSL encryption.
The access via
file:// can be used when both Subversion and Git repositories are hosted on the same machine. In this case, the local operating system account is used for authentication, and no additional settings are required.
All the other access methods to a Subversion repository require the appropriate authentication settings for SubGit.
Depending on the configuration, your Subversion server can request the following authentication data to log in to a Subversion repository:
- a username and a password
- an SSL client certificate
- an SSH private key
In the [auth "default"] section of the SubGit configuration file, you can specify the authentication settings depending on the authentication data that is required to log in to a Subversion repository.
SubGit refers to these settings in the sequence presented below. If some setting is not specified or the credentials fetched from the setting are not valid, SubGit refers to the next one until it is able to log in to a Subversion repository.
passwordssetting that refers to the passwords file for a username-password pair.
- A credential helper program.
- Subversion credentials cache from the Subversion client configuration directory.
If none of the settings is specified or fetched credentials are not valid, SubGit reports the authentication error.
The userName and password settings
passwordsettings specify a username and a password to access a Subversion repository.
The password is stored as plain text. For security reason, it is recommended to limit the access to the SubGit configuration file.
The passwords setting
passwordssetting defines a path to the passwords file that can contain the list of username-password pairs to log in to a Subversion repository. The path can be either absolute or relative to the Git repository.
The default value:
The default password file is located in the subgit directory within a Git repository. In this file, you can specify the list of username-password pairs as plain text in the following format:
The credentials from the passwords file may be used for mapping Git authors to Subversion revision authors when you translate Git commits to Subversion revisions. For the mapping purpose, you can specify the list of available usernames and passwords in the passwords file, though it is not obligatory. For more information on authors mapping, refer to the Authors Mapping section.
When you have several Git repositories mapped from the same Subversion repository, you can log in to this Subversion repository using a single passwords file.
Using credential helper programs
To enable a credential helper program, specify the following setting:
credentialHelper setting defines a path to a credential helper program and its optional arguments. The path can be either absolute or relative to the Git repository.
The initial SubGit configuration places the sample credential helper script (the
credentialHelper.sh file) to the
subgit/samples directory in the Git repository.
The initial script contains the following:
You can configure this script to fetch the credentials from some external source to log in to a Subversion repository. Use the standard Git credential helper input/output format with the exception that the command name is not required.
Using the Subversion credentials cache
To enable the authentication with Subversion credentials cache, specify the following settings:
subversionConfigurationDirectory setting defines a path to a Subversion directory that stores credentials' cache.
useDefaultSubversionConfigurationDirectory setting specifies whether SubGit will use the default Subversion configuration directory to obtain the authentication data or not.
The 1st setting takes priority over the 2nd. If the path to the appropriate Subversion directory with caсhed credentials is specified, SubGit refers to it and ignores the default Subversion configuration directory.
The location of the default Subversion configuration directory and the way the credentials cache is stored in it depend on the operating system that you use. The usual configuration is the following:
- On Windows
Subversion clients store encrypted passwords in the
%APPDATA%\Subversion\auth\svn.simple directory. Passwords are encrypted by the standard Windows cryptographic services.
- On Mac OS X
The Subversion authentication realm and usernames are stored in the
~/.subversion/auth/svn.simple directory. The encrypted passwords are stored in macOS Keychain.
- On Unix-like operating systems
By default, Subversion clients ask permission to store unencrypted passwords in the
~/.subversion/auth/svn.simple directory. The secure storage can be provided by the GNOME Keyring, KDE Wallet or GnuPG Agent services.
Currently, SubGit supports only GNOME Keyring.
The example below shows how to use the Subversion credentials cache with encrypted passwords on Linux.
Example: Use of credentials cache with encrypted passwords on Linux
All the passwords stores are disabled in the Subversion configuration file:
To enable a password store, in the Subversion configuration file, uncomment a password-stores line and specify the store that you want to enable.
Currently, SubGit supports only GNOME Keyring.
password-stores = gnome-keyring
In a Subversion client, run any command that prompts for the credentials to a Subversion server, for example,
svn info url. After that the credentials cache is stored in a text file in the
~/.subversion/auth/svn.simpledirectory. The encrypted password is stored in GNOME keyring.
SubGit can use the credentials cache from this directory to log in to a Subversion repository.
sshKeyFile setting defines a path to the file that contains the SSH private key to log in to a Subversion repository. The path can be either absolute or relative to the Git repository.
Make sure that a SubGit user is granted the reading permissions for an SSH private key file.
sshKeyFilePassphrase setting specifies a passphrase that can be optionally used to protect the SSH private key.
SubGit also requires a Subversion username when using the SSH key-based authentication. In this case, the username can be specified in one of the following settings:
sslClientCertFile setting defines a path to the SSL client certificate file in PKSC#12 format. The path can be either absolute or relative to the Git repository.
sslClientCertPassphrase setting specifies a passphrase that can be optionally used to protect the SSL certificate.
A web server that hosts a Subversion repository can be configured to request a username and password after the authentication with an SSL client certificate. For the information on the settings that you can use to specify a username and password, see the Specifying a username and a password section.
The other way to specify a path to an SSL client certificate and an optional passphrase is the the Subversion
servers file that is located in the default Subversion configuration directory.
In this case, no additional settings are required in the [auth "default"] section of the SubGit configuration file. SubGit refers to the
servers file for an SSL certificate to log in to a Subversion repository.
If a web server that hosts a Subversion repository along with an SSL client certificate requires a username and a password for authentication, SubGit refers to the
servers configuration file for an SSL certificate and uses the Subversion credentials cache to log in to a Subversion repository. To specify the settings that fetch the Subversion credentials cache, see the Using the Subversion credentials cache section.