Skip to content

Commit 93595af

Browse files
authored
Merge pull request #32 from AzureAD/dev
Release v0.1.0-preview
2 parents a1a6231 + 6f863c2 commit 93595af

File tree

204 files changed

+19991
-14
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

204 files changed

+19991
-14
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,8 @@
1919
*.tar.gz
2020
*.rar
2121

22+
# Intellij
23+
.idea/
24+
2225
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
2326
hs_err_pid*

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
1-
2-
# Contributing
3-
4-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
5-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
6-
the rights to use your contribution. For details, visit https://cla.microsoft.com.
7-
8-
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
9-
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
10-
provided by the bot. You will only need to do this once across all repos using our CLA.
11-
12-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
13-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
14-
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
1+
# Microsoft Authentication Library (MSAL) for Java
2+
3+
The MSAL library for Java gives your app the ability to begin using the Microsoft Cloud by supporting Microsoft Azure Active Directory and Microsoft Accounts in a converged experience using industry standard OAuth2 and OpenID Connect.
4+
5+
The library is currently in preview. During the preview we reserve the right to make changes to the API, cache format, and other mechanisms of this library without notice which you will be required to take along with bug fixes or feature improvements
6+
## Contribution
7+
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
8+
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
9+
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

RELEASES.md

Whitespace-only changes.

build/credscan-exclude.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"tool": "Credential Scanner",
3+
"suppressions": [
4+
{
5+
"file": "test-certificate.pfx",
6+
"_justification": "test self signed certificate to test signing from the library. this certificate is not associated with any tenant"
7+
},
8+
{
9+
"placeholder": "client_secret",
10+
"_justification" : "credential used for testing. not associated with any tenant"
11+
},
12+
{
13+
"placeholder": "ClientPassword",
14+
"_justification" : "credential used for testing. not associated with any tenant"
15+
}
16+
]
17+
}

build/findbugs-exclude.xml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<FindBugsFilter>
3+
<!-- Experimental and not fully vetted bug patterns -->
4+
<Match>
5+
<Bug pattern="CRLF_INJECTION_LOGS"/>
6+
</Match>
7+
<Match>
8+
<Bug pattern="XXE_DOCUMENT"/>
9+
</Match>
10+
<Match>
11+
<Bug pattern="XPATH_INJECTION"/>
12+
</Match>
13+
<Match>
14+
<Bug pattern="FORMAT_STRING_MANIPULATION"/>
15+
</Match>
16+
<Match>
17+
<Bug pattern="WEAK_MESSAGE_DIGEST_SHA1"/>
18+
</Match>
19+
<Match>
20+
<Bug pattern="DM_DEFAULT_ENCODING"/>
21+
</Match>
22+
<Match>
23+
<Bug pattern="DM_CONVERT_CASE"/>
24+
</Match>
25+
<Match>
26+
<Bug pattern="REC_CATCH_EXCEPTION"/>
27+
</Match>
28+
</FindBugsFilter>

changelog.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Version 0.0.1-preview
2+
=============
3+
Public preview of Microsoft Authentication Library for Java
4+
- Feature parity with ADAL Java
5+
- Updated public API to use builder pattern
6+
- Added telemetry callback
7+
- Added support for caching tokens
8+
- Added acquire token with silent parameters API

contributing.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# CONTRIBUTING
2+
3+
Microsoft Authentication Library for Java welcomes new contributors. This document will guide you
4+
through the process.
5+
6+
### CONTRIBUTOR LICENSE AGREEMENT
7+
8+
Please visit [https://cla.microsoft.com/](https://cla.microsoft.com/) and sign the Contributor License
9+
Agreement. You only need to do that once. We can not look at your code until you've submitted this request.
10+
11+
12+
### FORK
13+
14+
Fork the project [on GitHub](https://github.com/AzureAD/microsoft-authentication-library-for-java) and check out
15+
your copy.
16+
17+
Example for MSAL Java:
18+
19+
```
20+
$ git clone [email protected]:username/microsoft-authentication-library-for-java.git
21+
$ cd microsoft-authentication-library-for-java
22+
$ git remote add upstream [email protected]:AzureAD/microsoft-authentication-library-for-java.git
23+
```
24+
25+
Now decide if you want your feature or bug fix to go into the dev branch
26+
or the master branch. **All bug fixes and new features should go into the dev branch.**
27+
28+
The master branch is effectively frozen; patches that change the SDKs
29+
protocols or API surface area or affect the run-time behavior of the SDK will be rejected.
30+
31+
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
32+
projects. Do not send your patch to us, we cannot accept it.
33+
34+
In case of doubt, open an issue in the [issue tracker](https://github.com/AzureAD/microsoft-authentication-library-for-java/issues).
35+
36+
Especially do so if you plan to work on a major change in functionality. Nothing is more
37+
frustrating than seeing your hard work go to waste because your vision
38+
does not align with our goals for the SDK.
39+
40+
41+
### BRANCH
42+
43+
Okay, so you have decided on the proper branch. Create a feature branch
44+
and start hacking:
45+
46+
```
47+
$ git checkout -b my-feature-branch
48+
```
49+
50+
### COMMIT
51+
52+
Make sure git knows your name and email address:
53+
54+
```
55+
$ git config --global user.name "J. Random User"
56+
$ git config --global user.email "[email protected]"
57+
```
58+
59+
Writing good commit logs is important. A commit log should describe what
60+
changed and why. Follow these guidelines when writing one:
61+
62+
1. The first line should be 50 characters or less and contain a short
63+
description of the change prefixed with the name of the changed
64+
subsystem (e.g. "net: add localAddress and localPort to Socket").
65+
2. Keep the second line blank.
66+
3. Wrap all other lines at 72 columns.
67+
68+
A good commit log looks like this:
69+
70+
```
71+
fix: explaining the commit in one line
72+
73+
Body of commit message is a few lines of text, explaining things
74+
in more detail, possibly giving some background about the issue
75+
being fixed, etc etc.
76+
77+
The body of the commit message can be several paragraphs, and
78+
please do proper word-wrap and keep columns shorter than about
79+
72 characters or so. That way `git log` will show things
80+
nicely even when it is indented.
81+
```
82+
83+
The header line should be meaningful; it is what other people see when they
84+
run `git shortlog` or `git log --oneline`.
85+
86+
Check the output of `git log --oneline files_that_you_changed` to find out
87+
what directories your changes touch.
88+
89+
90+
### REBASE
91+
92+
Use `git rebase` (not `git merge`) to sync your work from time to time.
93+
94+
```
95+
$ git fetch upstream
96+
$ git rebase upstream/v0.1 # or upstream/master
97+
```
98+
99+
100+
### TEST
101+
102+
Bug fixes and features should come with tests. Add your tests in the
103+
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
104+
structured (license boilerplate, common includes, etc.).
105+
106+
107+
Make sure that all tests pass.
108+
109+
110+
### PUSH
111+
112+
```
113+
$ git push origin my-feature-branch
114+
```
115+
116+
Go to https://github.com/username/microsoft-authentication-library-for-java.git and select your feature branch. Click
117+
the 'Pull Request' button and fill out the form.
118+
119+
Pull requests are usually reviewed within a few days. If there are comments
120+
to address, apply your changes in a separate commit and push that to your
121+
feature branch. Post a comment in the pull request afterwards; GitHub does
122+
not send out notifications when you add commits.

0 commit comments

Comments
 (0)