Skip to content

Commit 418f8ec

Browse files
author
Vivek Sachdeva
committed
Merge branch 'master' of https://github.com/Internet2/grouper 
2 parents 3423494 + 7372557 commit 418f8ec

File tree

72 files changed

+6748
-70002
lines changed

Some content is hidden

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

72 files changed

+6748
-70002
lines changed

‎grouper-misc/grouper-azure/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

‎grouper-misc/grouper-azure/README.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Azure AD Provisioner
2+
3+
This project is an Internet2 Grouper connector that synchronizes Grouper groups and users to Microsoft Azure Active Directory/Office 365.
4+
5+
Note that this currently only supports security groups. Support for other group types is planned.
6+
7+
# Installing
8+
9+
1. build
10+
11+
```
12+
mvn clean package
13+
mvn dependency:copy-dependencies
14+
```
15+
16+
2. copy contents of file to grouper home
17+
18+
(2.5+ Docker container)
19+
```
20+
cp target/grouper-azure-provisioner-2.5.0-SNAPSHOT.jar /opt/grouperContainer/lib/
21+
cp target/dependency/* /opt/grouperContainer/lib/
22+
```
23+
24+
(2.3, 2.4)
25+
```
26+
cp target/grouper-azure-provisioner-2.5.0-SNAPSHOT.jar /opt/grouper.apiBinary-{version}/lib/custom
27+
cp target/dependency/* /opt/grouper.apiBinary-{version}/lib/custom
28+
```
29+
30+
# Configuring
31+
32+
The provisioning attribute to add to the provisionable object is `etc:attribute:office365:o365Sync`. If set on a folder,
33+
all groups under this folder (recursively) will be automatically provisioned. Alternatively, the attribute can be set on
34+
an individual group. _It is not recommended to assign directly to a group_, as there is currently a race condition that
35+
may occur in the current version of this code (i.e., if the changelog consumer runs after group creation but before
36+
attribute assignment, provisioning will not occur).
37+
38+
1. Set up stem for provisioning and ID attribute
39+
40+
```
41+
GrouperSession grouperSession = GrouperSession.startRootSession();
42+
AttributeDef provisioningMarkerAttributeDef = new AttributeDefSave(grouperSession).assignCreateParentStemsIfNotExist(true).assignName("etc:attribute:office365:o365SyncDef").assignToStem(true).assignToGroup(true).save();
43+
AttributeDefName provisioningMarkerAttributeName = new AttributeDefNameSave(grouperSession, provisioningMarkerAttributeDef).assignName("etc:attribute:office365:o365Sync").save();
44+
45+
rootStem = addStem("", "test", "test");
46+
rootStem.getAttributeDelegate().assignAttribute(provisioningMarkerAttributeName);
47+
48+
AttributeDef o365Id = new AttributeDefSave(grouperSession).assignCreateParentStemsIfNotExist(true).assignName("etc:attribute:office365:o365IdDef").assignToGroup(true).assignValueType(AttributeDefValueType.string).save();
49+
AttributeDefName o365IdName = new AttributeDefNameSave(grouperSession, o365Id).assignName("etc:attribute:office365:o365Id").save();
50+
```
51+
52+
2. Configure loader job in `grouper-loader.properties`. Note that you will need to set up an application with access to your domain.
53+
See documentation at [http://graph.microsoft.io/en-us/docs].
54+
55+
```
56+
changeLog.consumer.o365.class = edu.internet2.middleware.grouper.changeLog.consumer.Office365ChangeLogConsumer
57+
# fire every 5 seconds
58+
changeLog.consumer.o365.quartzCron = 0,5,10,15,20,25,30,35,40,45,50,55 * * * * ?
59+
changeLog.consumer.o365.syncAttributeName = etc:attribute:office365:o365Sync
60+
changeLog.consumer.o365.retryOnError = true
61+
changeLog.consumer.o365.tenantId = @o365.tenantId@
62+
changeLog.consumer.o365.clientId = @o365.clientId@
63+
changeLog.consumer.o365.clientSecret = @o365.clientSecret@
64+
#changeLog.consumer.o365.idAttribute =
65+
#changeLog.consumer.o365.groupJexl =
66+
67+
```
68+
69+
Replace `@o365.tenantId@`, `@o365.clientId@` and `@o365.clientSecret@` with appropriate values from the application configuration.
70+
71+
The property `idAttribute` specifies what attribute is used to build the Azure user principal, and will default to "uid" if not set.
72+
The Azure principal will get built as idattribute + "@" + tenantId. Whatever attribute is used must be available as a key as
73+
returned in `subject.getAttributes()`; i.e., if you want to use the subject's id or identifier, it needs to be defined in the
74+
subject attributes too.
75+
76+
If `groupJexl` is defined, it will be used to calculate the Azure group name, instead of the group name including
77+
the path. The variable `group` is available within the jexl scriptlet to represent the group object. Brackets are
78+
not needed around the scriptlet. For example:
79+
80+
`group.name.replaceAll("^app:azure:", "").replaceAll(":", "_")`
81+
82+
will remove the initial prefix "app:azure:" from the group path, and replace all folder separators with underscores.
83+
84+
# Office 365 Notes
85+
86+
Login to the app management console:
87+
88+
https://apps.dev.microsoft.com/
89+
90+
For first time use, create Office 365 account first:
91+
92+
* Enroll in Office 365 (30-day trail account is fine), during enrollment, note the tenant value of the form "abcdef.onmicrosoft.com"
93+
* At Office 365 management portal, click "Azure AD" link
94+
* In Azure AD portal, click "Azure Activity Directory"
95+
* Under "Manage" tab, click "App registrations"
96+
* In intro text "To view and manage your registrations for converged applications, please visit the Microsoft Application Console.", click that link
97+
98+
Once in the App Mgmt Console, create an app:
99+
* Note the "Application Id" that is generated (this will be the client id for OAuth2 tokens)
100+
* Use "Generate New Password" when creating keys (this is the client secret for OAuth2 tokens)
101+
* Under "Platforms" tab, click "Add Platform" and specify a redirect URL like "http://localhost/grouper"
102+
* Under "Microsoft Graph Permissions", in "Application Permissions" specify required Graph API permissions
103+
* At bottom of page, click "Save"
104+
* IMPORTANT: after permissions are added (or modified) admin consent must be granted at the URL template:
105+
https://login.microsoftonline.com/$TENANT/adminconsent?client_id=$APPLICATION_ID
106+
107+
# Graph API Notes
108+
109+
To get a token for making Graph API calls, do the following:
110+
111+
* POST http method
112+
* URL is of the form https://login.microsoftonline.com/$TENANT/oauth2/v2.0/token
113+
114+
Use the following request parameters:
115+
* client_secret - specify password generated from "Generate New Password" above
116+
* client_id - specify Application Id that's generated when creating app
117+
* grant_type - specify client_credentials, this value implies "Application Permissions" (as opposed to "Delegated Permissions")
118+
* redirect_uri - specify http://localhost/grouper
119+
* scope - specify https://graph.microsoft.com/.default
120+
121+
# Acknowledgments
122+
123+
The Office365/Azure provisioner for Grouper originated as a project from Unicon, Inc. Primary developers were Bill
124+
Thompson, Jj, and John Gasper, with other contributions by Chris Hyzer and Russ Trotter. The source project can be
125+
found at https://github.com/Unicon/office365-and-azure-ad-grouper-provisioner .
126+
127+
This project includes contributions from Kansas State University, project https://github.com/kstateome/office365-and-azure-ad-grouper-provisioner.git.
128+
Principal development was done by David Malia, with contribution by Kurt Zoglmann.

‎grouper-misc/grouper-azure/pom.xml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5+
<modelVersion>4.0.0</modelVersion>
6+
7+
<parent>
8+
<groupId>edu.internet2.middleware.grouper</groupId>
9+
<artifactId>grouper-parent</artifactId>
10+
<version>2.5.0-SNAPSHOT</version>
11+
<relativePath>../../grouper-parent</relativePath>
12+
</parent>
13+
14+
<name>Grouper Office365 and Azure Provisioner</name>
15+
<description>Office365 and Azure Apps Integration Library</description>
16+
<artifactId>grouper-azure-provisioner</artifactId>
17+
<packaging>jar</packaging>
18+
19+
<dependencies>
20+
<dependency>
21+
<groupId>com.squareup.retrofit2</groupId>
22+
<artifactId>retrofit</artifactId>
23+
<version>2.7.2</version>
24+
</dependency>
25+
<dependency>
26+
<groupId>com.squareup.retrofit2</groupId>
27+
<artifactId>converter-moshi</artifactId>
28+
<version>2.7.2</version>
29+
</dependency>
30+
<dependency>
31+
<groupId>com.squareup.okhttp3</groupId>
32+
<artifactId>logging-interceptor</artifactId>
33+
<version>3.14.7</version>
34+
</dependency>
35+
<dependency>
36+
<groupId>org.apache.commons</groupId>
37+
<artifactId>commons-jexl</artifactId>
38+
<version>2.1.1</version>
39+
</dependency>
40+
<!-- if we starting uing com.microsoft.graph:microsoft-graph:jar, it will include this same gson library -->
41+
<dependency>
42+
<groupId>com.google.code.gson</groupId>
43+
<artifactId>gson</artifactId>
44+
<version>2.8.2</version>
45+
</dependency>
46+
47+
<dependency>
48+
<groupId>edu.internet2.middleware.grouper</groupId>
49+
<artifactId>grouper</artifactId>
50+
<version>${project.version}</version>
51+
<scope>provided</scope>
52+
</dependency>
53+
</dependencies>
54+
55+
</project>

0 commit comments

Comments
 (0)