Kusig / bitbucket-remote-user-sso

Bitbucket Server (former: stash) remote user single sign on authenticator russo-stash: Authenticating to Stash with the X_Forwarded_User HTTP header. Note that I don't have time to work on this, feel free to fork. You are free to use and modify it at your own risk, I hope it is still helpful.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BitBucket Server plugin for http header authentication (SSO / Kerberos)

This plugin provides authentication based on a http header (default: X_Forwarded_User). The authenticator will fall back to the default BitBucket Server authenticator, so everything external should keep working as expected.

WARNING: This plugin is currently not actively developed or maintained. It was created for an organisation that no longer does or uses FOSS, so it was moved. Feel free to use it at your own risk, or to fork and improve it. I hope it is helpful anyway.

This plugin is for BitBucket Server. For the older stash product see my GitHub account for a different version.

License

This software is distributed under the MIT License. See COPYING for details.

Build

Register the Atlassian Maven repos in your $HOME/.m2/settings.xml. Extend it with the following repository profiles:

		<repositories>
			<repository>
				<id>atlassian-public</id>
				<url>https://maven.atlassian.com/repository/public</url>
				<snapshots>
					<enabled>true</enabled>
					<updatePolicy>never</updatePolicy>
					<checksumPolicy>warn</checksumPolicy>
				</snapshots>
				<releases>
					<enabled>true</enabled>
					<checksumPolicy>warn</checksumPolicy>
				</releases>
			</repository>
			<repository>
				<id>atlassian-plugin-sdk</id>
				<url>file://${HOME}/.m2/repository</url>
				<snapshots>
					<enabled>true</enabled>
				</snapshots>
				<releases>
					<enabled>true</enabled>
					<checksumPolicy>warn</checksumPolicy>
				</releases>
			</repository>
		</repositories>
		<pluginRepositories>
			<pluginRepository>
				<id>atlassian-public</id>
				<url>https://maven.atlassian.com/repository/public</url>
				<releases>
					<enabled>true</enabled>
					<checksumPolicy>warn</checksumPolicy>
				</releases>
				<snapshots>
					<updatePolicy>never</updatePolicy>
					<checksumPolicy>warn</checksumPolicy>
				</snapshots>
			</pluginRepository>
			<pluginRepository>
				<id>atlassian-plugin-sdk</id>
				<url>file://${HOME}/.m2/repository</url>
				<releases>
					<enabled>true</enabled>
					<checksumPolicy>warn</checksumPolicy>
				</releases>
				<snapshots>
					<enabled>true</enabled>
				</snapshots>
			</pluginRepository>
		</pluginRepositories>

Build it with mvn install

Alternative way to build

  • Get the Atlassian SDK as described at Atlassian
  • Build the .jar file with the atlas-package command in the root folder (containing the pom.xml)

Install

There are a few things you need in order to install this plugin:

  • Stop your BitBucket Server instance if it is running
  • Copy the target/russo-1.0.jar file to the WEB-INF/libs folder of your BitBucket Server installation
  • Modify the WEB-INF/classes/stash-plugins/authentication.xml file by commenting out existing auth classes and adding
  • Restart your BitBucket Server instance
  • If it doesn't work as expected, check your logs. If you need more verbose information, set useDebug to true and recompile and reinstall the package

Configuring your httpd

In order to get it to work, you need to configure your httpd (e.g. Apache httpd) to do the authentication and set the header. For security reasons you should make sure that user-set headers are removed, otherwise users will be able to spoof authentication and log in as a different user!

Example Apache configuration

<VirtualHost *:443>
SSLEngine on
SSLCertificateFile /etc/pki/tls/certs/mypubliccert.pem
SSLCertificateKeyFile /etc/pki/tls/private/privatekey.pem
ProxyPreserveHost On
ProxyRequests Off
ServerName bitbucket.mycompany.tld
ProxyPass / http://localhost:8080/
ProxyPassReverse / http://localhost:8080/
SSLProxyEngine On

    <Location />
        AuthType Kerberos
        AuthName "Bitbucket Server Kerberos Auth"
        KrbMethodNegotiate On
        KrbMethodK5Passwd On
        KrbAuthRealms MYREALM
        Krb5KeyTab /etc/httpd/httpd.keytab
        KrbLocalUserMapping On
        require valid-user
        RequestHeader set X-Forwarded-User %{REMOTE_USER}s
    </Location>
</VirtualHost>

About

Bitbucket Server (former: stash) remote user single sign on authenticator russo-stash: Authenticating to Stash with the X_Forwarded_User HTTP header. Note that I don't have time to work on this, feel free to fork. You are free to use and modify it at your own risk, I hope it is still helpful.

License:MIT License


Languages

Language:Java 100.0%