Retrieve OAuth2 or Personal Accesss Tokens for Visual Studio Team Services (visualstudio.com) accounts. Also provides secure storage for those secrets on different platforms.

Перейти к файлу

Yang Cao edee296b96 Update README		2018-08-13 21:52:57 -04:00
common	[maven-release-plugin] prepare for next development iteration	2018-08-13 21:41:08 -04:00
config/checkstyle	Add License file, enforce license header	2015-09-25 15:16:34 -04:00
core	[maven-release-plugin] prepare for next development iteration	2018-08-13 21:41:08 -04:00
providers	[maven-release-plugin] prepare for next development iteration	2018-08-13 21:41:08 -04:00
sample	Update README	2018-08-13 21:52:57 -04:00
storage	[maven-release-plugin] prepare for next development iteration	2018-08-13 21:41:08 -04:00
.gitattributes	Txt files should also be considered text	2016-06-28 11:37:13 -04:00
.gitignore	ignore maven plugins generated artifacts	2016-07-01 09:55:38 -04:00
.travis.yml	Build with Java 8 instead of Java 6 (#18 )	2018-06-18 08:10:41 -04:00
LICENSE.txt	Remove the year in the license file.	2016-06-29 16:47:45 -04:00
README.md	Update README	2018-08-13 21:52:57 -04:00
ThirdPartyNotices.txt	Update ThirdPartyNotice.txt and remove binary version of eula	2016-07-01 09:52:21 -04:00
pom.xml	[maven-release-plugin] prepare for next development iteration	2018-08-13 21:41:08 -04:00
settings.xml	Clean up pom and add a setting file so we can deploy from build agent	2016-04-11 13:10:23 -04:00

README.md

Visual Studio Team Services Authentication Library for Java (Preview)

Retrieve OAuth2 Access Token or Personal Accesss Tokens for Visual Studio Team Services (visualstudio.com) accounts. Also provides secure storage for those secrets on different platforms.

To learn more about Visual Studio Team Services and our Java specific tools, please visit https://java.visualstudio.com.

What this library provides

This library provides:

a set of authenticators in the core module that can be used to retrieve credentials in the form of OAuth2 Access Token or Personal Access Token against any Visual Studio Team Services account.
a set of secure storage providers that store retrieved secrets, as well as In memory and File system backed insecure storages.
a set of providers that hide the interaction between storage and authenticator, and returns authenticated client that can be used directly against Visual Studio Team Services REST APIs.

Available Secure Storage Providers:

Secret Type	Windows (Credential Manager)	Linux (GNOME Keyring v2.22+)	Mac OSX (Keychain)
Username / Password Combo (`Credential`)	Yes	Yes	Yes
OAuth2 Access/Refresh Token (`TokenPair`)	Yes (On Windows 7, 8/8.1 and 10)	Yes	Yes
VSTS Personal Access Token (`Token`)	Yes	Yes	Yes

How to use this library

Maven is the preferred way to referencing this library.

  <dependency>
    <groupId>com.microsoft.alm</groupId>
    <artifactId>auth-providers</artifactId>
    <version>0.6.4</version>
  </dependency>

If only interested in specific modules:

  <dependency>
    <groupId>com.microsoft.alm</groupId>
    <artifactId>auth-secure-storage</artifactId>
    <version>0.6.4</version>
  </dependency>

  <dependency>
    <groupId>com.microsoft.alm</groupId>
    <artifactId>auth-core</artifactId>
    <version>0.6.4</version>
  </dependency>

Here is a Sample App that uses this library.

How to build

Oracle JDK 6
Maven 3.2+
mvn clean verify

How can I contribute?

This is a preview release, please open issues and give us feedback! We also welcome Pull Requests.

License

The MIT license can be found in LICENSE.txt

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.