Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README.md, CONTRIBUTING.md and CODE_OF_CONDUCT.md (#77)
- Loading branch information
Showing
3 changed files
with
178 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Contributor Code of Conduct | ||
|
|
||
| As contributors and maintainers of this project, | ||
| and in the interest of fostering an open and welcoming community, | ||
| we pledge to respect all people who contribute through reporting issues, | ||
| posting feature requests, updating documentation, | ||
| submitting pull requests or patches, and other activities. | ||
|
|
||
| We are committed to making participation in this project | ||
| a harassment-free experience for everyone, | ||
| regardless of level of experience, gender, gender identity and expression, | ||
| sexual orientation, disability, personal appearance, | ||
| body size, race, ethnicity, age, religion, or nationality. | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery | ||
| * Personal attacks | ||
| * Trolling or insulting/derogatory comments | ||
| * Public or private harassment | ||
| * Publishing other's private information, | ||
| such as physical or electronic | ||
| addresses, without explicit permission | ||
| * Other unethical or unprofessional conduct. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or reject | ||
| comments, commits, code, wiki edits, issues, and other contributions | ||
| that are not aligned to this Code of Conduct. | ||
| By adopting this Code of Conduct, | ||
| project maintainers commit themselves to fairly and consistently | ||
| applying these principles to every aspect of managing this project. | ||
| Project maintainers who do not follow or enforce the Code of Conduct | ||
| may be permanently removed from the project team. | ||
|
|
||
| This code of conduct applies both within project spaces and in public spaces | ||
| when an individual is representing the project or its community. | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior | ||
| may be reported by opening an issue | ||
| or contacting one or more of the project maintainers. | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, | ||
| available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # How to become a contributor and submit your own code | ||
|
|
||
| ## Contributor License Agreements | ||
|
|
||
| We'd love to accept your patches! Before we can take them, we have to jump a couple of legal | ||
| hurdles. | ||
|
|
||
| Please fill out either the individual or corporate Contributor License Agreement (CLA). | ||
|
|
||
| * If you are an individual writing original source code and you're sure you own the intellectual | ||
| property, then you'll need to sign an [individual CLA] | ||
| (https://developers.google.com/open-source/cla/individual). | ||
| * If you work for a company that wants to allow you to contribute your work, then you'll need to | ||
| sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate). | ||
|
|
||
| Follow either of the two links above to access the appropriate CLA and instructions for how to sign | ||
| and return it. Once we receive it, we'll be able to accept your pull requests. | ||
|
|
||
| ## Contributing A Patch | ||
|
|
||
| 1. Submit an issue describing your proposed change. | ||
| 2. The repo owner will respond to your issue promptly. | ||
| 3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License | ||
| Agreement (see details above). | ||
| 4. Fork the repo, develop and test your code changes. | ||
| 5. Ensure that your code adheres to the existing style. Refer to the | ||
| [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) for the recommended | ||
| coding standards. | ||
| 6. Ensure that your code has an appropriate set of unit tests which all pass. | ||
| 7. Submit a pull request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,105 @@ | ||
| # google-auth-library-java | ||
| # Open source Auth client library for Java | ||
| Google Auth Library | ||
| =================== | ||
|
|
||
| Open source authentication client library for Java. | ||
|
|
||
| [](https://travis-ci.org/google/google-auth-library-java.svg) | ||
| [](https://img.shields.io/maven-central/v/com.google.auth/google-auth-library-credentials.svg) | ||
|
|
||
| - [API Documentation] (https://google.github.io/google-auth-library-java/releases/0.5.0/apidocs) | ||
|
|
||
| This project consists of 3 artifacts: | ||
|
|
||
| - [*google-auth-library-credentials*](#google-auth-library-credentials): contains base classes and | ||
| interfaces for Google credentials | ||
| - [*google-auth-library-appengine*](#google-auth-library-appengine): contains App Engine | ||
| credentials. This artifacts depends on the App Engine SDK | ||
| - [*google-auth-library-oauth2-http*](#google-auth-library-oauth2-http): contains a wide variety of | ||
| credentials as well as utility methods to create them and to get Application Default Credentials | ||
|
|
||
| > Note: This client is a work-in-progress, and may occasionally | ||
| > make backwards-incompatible changes. | ||
| Quickstart | ||
| ---------- | ||
|
|
||
| If you are using Maven, add this to your pom.xml file (notice that you can replace | ||
| `google-auth-library-oauth2-http` with any of `google-auth-library-credentials` and | ||
| `google-auth-library-appengine`, depending on your application needs): | ||
| ```xml | ||
| <dependency> | ||
| <groupId>com.google.auth</groupId> | ||
| <artifactId>google-auth-library-oauth2-http</artifactId> | ||
| <version>0.5.0</version> | ||
| </dependency> | ||
| ``` | ||
| If you are using Gradle, add this to your dependencies | ||
| ```Groovy | ||
| compile 'com.google.auth:google-auth-library-oauth2-http:0.5.0' | ||
| ``` | ||
| If you are using SBT, add this to your dependencies | ||
| ```Scala | ||
| libraryDependencies += "com.google.auth" % "google-auth-library-oauth2-http" % "0.5.0" | ||
| ``` | ||
|
|
||
| google-auth-library-credentials | ||
| ------------------------------- | ||
|
|
||
| This artifact contains base classes and interfaces for Google credentials: | ||
| - `Credentials`: base class for an authorized identity. Implementations of this class can be used to | ||
| authorize your application | ||
| - `RequestMetadataCallback`: interface for the callback that receives the result of the asynchronous | ||
| `Credentials.getRequestMetadata(URI, Executor, RequestMetadataCallback)` | ||
| - `ServiceAccountSigner`: interface for a service account signer. Implementations of this class are | ||
| capable of signing byte arrays using the credentials associated to a Google Service Account | ||
|
|
||
| google-auth-library-appengine | ||
| ----------------------------- | ||
| This artifact depends on the App Engine SDK (`appengine-api-1.0-sdk`) and should be used only by | ||
| applications running on App Engine. The `AppEngineCredentials` class allows to authorize your App | ||
| Engine application given an instance of [AppIdentityService](https://cloud.google.com/appengine/docs/java/javadoc/com/google/appengine/api/appidentity/AppIdentityService). | ||
|
|
||
| google-auth-library-oauth2-http | ||
| ------------------------------- | ||
|
|
||
| This artifact contains a wide variety of credentials as well as utility methods to create them and | ||
| to get Application Default Credentials. | ||
| Credentials classes contained in this artifact are: | ||
| - `CloudShellCredentials`: credentials for Google Cloud Shell built-in service account | ||
| - `CloudShellCredentials`: credentials for Google Compute Engine built-in service account | ||
| - `OAuth2Credentials`: base class for OAuth2-based credentials | ||
| - `ServiceAccountCredentials`: credentials for a Service Account - use a JSON Web Token (JWT) to get | ||
| access tokens | ||
| - `ServiceAccountJwtAccessCredentials`: credentials for a Service Account - use JSON Web Token (JWT) | ||
| directly in the request metadata to provide authorization | ||
| - `UserCredentials`: credentials for a user identity and consent | ||
|
|
||
| To get Application Default Credentials use `GoogleCredentials.getApplicationDefault()` or | ||
| `GoogleCredentials.getApplicationDefault(HttpTransportFactory)`. These methods return the | ||
| Application Default Credentials which are used to identify and authorize the whole application. The | ||
| following are searched (in order) to find the Application Default Credentials: | ||
|
|
||
| 1. Credentials file pointed to by the `GOOGLE_APPLICATION_CREDENTIALS` environment variable | ||
| 2. Credentials provided by the Google Cloud SDK `gcloud auth application-default login` command | ||
| 3. Google App Engine built-in credentials | ||
| 4. Google Cloud Shell built-in credentials | ||
| 5. Google Compute Engine built-in credentials | ||
|
|
||
| To get Credentials from a Service Account JSON key use `GoogleCredentials.fromStream(InputStream)` | ||
| or `GoogleCredentials.fromStream(InputStream, HttpTransportFactory)`. | ||
|
|
||
| Contributing | ||
| ------------ | ||
|
|
||
| Contributions to this library are always welcome and highly encouraged. | ||
|
|
||
| See [CONTRIBUTING](CONTRIBUTING.md) documentation for more information on how to get started. | ||
|
|
||
| Please note that this project is released with a Contributor Code of Conduct. By participating in | ||
| this project you agree to abide by its terms. See [Code of Conduct](CODE_OF_CONDUCT.md) for more | ||
| information. | ||
|
|
||
| License | ||
| ------- | ||
|
|
||
| BSD 3-Clause - See [LICENSE](LICENSE) for more information. |