This repository has been archived by the owner on Jul 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* merge in dev
- Loading branch information
Showing
45 changed files
with
1,933 additions
and
712 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 |
---|---|---|
|
@@ -6,3 +6,4 @@ | |
**/test-output/* | ||
.idea/ | ||
/target | ||
*.iml |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) Microsoft Corporation | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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 |
---|---|---|
|
@@ -8,14 +8,29 @@ | |
[We provide a full suite of sample applications and documentation on GitHub](https://github.com/Azure-Samples) to help you get started with learning the Azure Identity system. This includes tutorials for native clients such as Windows, Windows Phone, iOS, macOS, Android, and Linux. We also provide full walkthroughs for authentication flows such as OAuth2, OpenID Connect, Graph API, and other awesome features. | ||
|
||
## Versions | ||
Current version - 1.4.0 | ||
Current version - 1.5.0 | ||
|
||
Minimum recommended version - 1.4.0 | ||
Minimum recommended version - 1.5.0 | ||
|
||
From version 1.3.0 support for handling Conditional Access claims challenge was added. You can read about CA [here](https://go.microsoft.com/fwlink/?linkid=855860) and refer this [sample](https://github.com/AzureAD/azure-activedirectory-library-for-java/tree/dev/src/samples/web-app-samples-for-adal4j) to handle it. | ||
|
||
You can find the changes for each version in the [change log](https://github.com/AzureAD/azure-activedirectory-library-for-java/blob/master/changelog.txt). | ||
|
||
## Logging | ||
|
||
ADAL for Java uses the Simple Logging Facade for Java (SLF4J) as a simple facade or abstraction for various logging frameworks. | ||
|
||
#### Personal Identifiable Information (PII) & Organizational Identifiable Information (OII) | ||
|
||
By default, ADAL logging does not capture or log any PII or OII. The library allows app developers to turn this on by configuring the logPii property on the AuthenticationContext. By turning on PII or OII, the app takes responsibility for safely handling highly-sensitive data and complying with any regulatory requirements. | ||
|
||
```java | ||
//PII or OII logging disabled. Default Logger does not capture any PII or OII | ||
AuthenticationContext context = new AuthenticationContext(...); | ||
|
||
//PII or OII logging enabled | ||
context.setLogPii(true); | ||
``` | ||
|
||
## Community Help and Support | ||
|
||
|
@@ -35,15 +50,3 @@ All code is licensed under the MIT License and we triage actively on GitHub. We | |
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
||
## Logging | ||
|
||
The Library uses The Simple Logging Facade for Java (SLF4J) as a simple facade or abstraction for various logging frameworks. | ||
|
||
For regular logs we use class names as logger names. | ||
For log which might contains Pii(personally identifiable information) class names preceded by prefix "adal4jPii." are used. | ||
So, for the same class, for instance Foo, we define two loggers: | ||
|
||
com.microsoft.aad.adal4j.Foo - no Pii data | ||
|
||
adal4jPii.com.microsoft.aad.adal4j.Foo - might contain Pii data | ||
|
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
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,126 @@ | ||
# CONTRIBUTING | ||
|
||
Azure Active Directory SDK projects welcomes new contributors. This document will guide you | ||
through the process. | ||
|
||
### CONTRIBUTOR LICENSE AGREEMENT | ||
|
||
Please visit [https://cla.microsoft.com/](https://cla.microsoft.com/) and sign the Contributor License | ||
Agreement. You only need to do that once. We can not look at your code until you've submitted this request. | ||
|
||
|
||
### FORK | ||
|
||
Fork the project [on GitHub][] and check out | ||
your copy. | ||
|
||
Example for ADAL Java: | ||
|
||
``` | ||
$ git clone [email protected]:username/azure-activedirectory-library-for-java.git | ||
$ cd azure-activedirectory-library-for-java | ||
$ git remote add upstream [email protected]:AzureAD/azure-activedirectory-library-for-java.git | ||
``` | ||
|
||
Now decide if you want your feature or bug fix to go into the dev branch | ||
or the master branch. **All bug fixes and new features should go into the dev branch.** | ||
|
||
The master branch is effectively frozen; patches that change the SDKs | ||
protocols or API surface area or affect the run-time behavior of the SDK will be rejected. | ||
|
||
Some of our SDKs have bundled dependencies that are not part of the project proper. Any changes to files in those directories or its subdirectories should be sent to their respective | ||
projects. Do not send your patch to us, we cannot accept it. | ||
|
||
In case of doubt, open an issue in the [issue tracker][]. | ||
|
||
Especially do so if you plan to work on a major change in functionality. Nothing is more | ||
frustrating than seeing your hard work go to waste because your vision | ||
does not align with our goals for the SDK. | ||
|
||
|
||
### BRANCH | ||
|
||
Okay, so you have decided on the proper branch. Create a feature branch | ||
and start hacking: | ||
|
||
``` | ||
$ git checkout -b my-feature-branch | ||
``` | ||
|
||
### COMMIT | ||
|
||
Make sure git knows your name and email address: | ||
|
||
``` | ||
$ git config --global user.name "J. Random User" | ||
$ git config --global user.email "[email protected]" | ||
``` | ||
|
||
Writing good commit logs is important. A commit log should describe what | ||
changed and why. Follow these guidelines when writing one: | ||
|
||
1. The first line should be 50 characters or less and contain a short | ||
description of the change prefixed with the name of the changed | ||
subsystem (e.g. "net: add localAddress and localPort to Socket"). | ||
2. Keep the second line blank. | ||
3. Wrap all other lines at 72 columns. | ||
|
||
A good commit log looks like this: | ||
|
||
``` | ||
fix: explaining the commit in one line | ||
Body of commit message is a few lines of text, explaining things | ||
in more detail, possibly giving some background about the issue | ||
being fixed, etc etc. | ||
The body of the commit message can be several paragraphs, and | ||
please do proper word-wrap and keep columns shorter than about | ||
72 characters or so. That way `git log` will show things | ||
nicely even when it is indented. | ||
``` | ||
|
||
The header line should be meaningful; it is what other people see when they | ||
run `git shortlog` or `git log --oneline`. | ||
|
||
Check the output of `git log --oneline files_that_you_changed` to find out | ||
what directories your changes touch. | ||
|
||
|
||
### REBASE | ||
|
||
Use `git rebase` (not `git merge`) to sync your work from time to time. | ||
|
||
``` | ||
$ git fetch upstream | ||
$ git rebase upstream/v0.1 # or upstream/master | ||
``` | ||
|
||
|
||
### TEST | ||
|
||
Bug fixes and features should come with tests. Add your tests in the | ||
test directory. This varies by repository but often follows the same convention of /src/test. Look at other tests to see how they should be | ||
structured (license boilerplate, common includes, etc.). | ||
|
||
|
||
Make sure that all tests pass. | ||
|
||
|
||
### PUSH | ||
|
||
``` | ||
$ git push origin my-feature-branch | ||
``` | ||
|
||
Go to https://github.com/username/azure-activedirectory-library-for-***.git and select your feature branch. Click | ||
the 'Pull Request' button and fill out the form. | ||
|
||
Pull requests are usually reviewed within a few days. If there are comments | ||
to address, apply your changes in a separate commit and push that to your | ||
feature branch. Post a comment in the pull request afterwards; GitHub does | ||
not send out notifications when you add commits. | ||
|
||
|
||
[on GitHub]: https://github.com/AzureAD/azure-activedirectory-library-for-java | ||
[issue tracker]: https://github.com/AzureAD/azure-activedirectory-library-for-java/issues |
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
45 changes: 45 additions & 0 deletions
45
src/main/java/com/microsoft/aad/adal4j/AcquireDeviceCodeCallable.java
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,45 @@ | ||
// Copyright (c) Microsoft Corporation. | ||
// All rights reserved. | ||
// | ||
// This code is licensed under the MIT License. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a copy | ||
// of this software and associated documentation files(the "Software"), to deal | ||
// in the Software without restriction, including without limitation the rights | ||
// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell | ||
// copies of the Software, and to permit persons to whom the Software is | ||
// furnished to do so, subject to the following conditions : | ||
// | ||
// The above copyright notice and this permission notice shall be included in | ||
// all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE | ||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
// THE SOFTWARE. | ||
|
||
package com.microsoft.aad.adal4j; | ||
|
||
class AcquireDeviceCodeCallable extends AdalCallable<DeviceCode> { | ||
private String clientId; | ||
private String resource; | ||
|
||
AcquireDeviceCodeCallable(AuthenticationContext context, | ||
String clientId, String resource, | ||
AuthenticationCallback<DeviceCode> callback) { | ||
super(context, callback); | ||
this.headers = new ClientDataHttpHeaders(context.correlationId); | ||
this.clientId = clientId; | ||
this.resource = resource; | ||
} | ||
|
||
DeviceCode execute() throws Exception { | ||
context.authenticationAuthority.doInstanceDiscovery(headers.getReadonlyHeaderMap(), | ||
context.proxy, context.sslSocketFactory); | ||
return DeviceCodeRequest.execute(context.authenticationAuthority.getDeviceCodeEndpoint(), | ||
clientId, resource, headers.getReadonlyHeaderMap(), context.proxy, context.sslSocketFactory); | ||
} | ||
} |
Oops, something went wrong.