Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ZEPPELIN-2598] Securing Zeppelin with OpenID Connect #2373

Closed
wants to merge 7 commits into from
Closed

[ZEPPELIN-2598] Securing Zeppelin with OpenID Connect #2373

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4ce9121
Enabling authentication with OpenId connect
andreaTP May 16, 2017
03bbe30
updates
andreaTP May 30, 2017
545686d
fix username after direct login
andreaTP May 30, 2017
7ec8cdd
reverted to a minimum
andreaTP Jun 1, 2017
80c375d
fixed style issues on master
andreaTP Jun 19, 2017
31270f2
Merge remote-tracking branch 'apache/master' into keycloak
andreaTP Jun 19, 2017
2d5af6d
merge with master
andreaTP Jun 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions conf/shiro.ini.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,33 @@ user3 = password4, role2
#zeppelinHubRealm.zeppelinhubUrl = https://www.zeppelinhub.com
#securityManager.realms = $zeppelinHubRealm

### A sample for configuring OIDC Pac4J managed login(i.e. Keycloak)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we could separate config here in similar way as in documentation, by separating oidc, clients, callbackFilter configuration by new line

#oidcConfig = org.pac4j.oidc.config.OidcConfiguration
#oidcConfig.discoveryURI = <your instance>/realms/<your realm>/.well-known/openid-configuration
#oidcConfig.clientId = <your client name>
#oidcConfig.secret = <your secret>
#oidcConfig.clientAuthenticationMethodAsString = client_secret_basic
#oidcClient = org.pac4j.oidc.client.OidcClient
#oidcClient.configuration = $oidcConfig
#clients = org.pac4j.core.client.Clients
#clients.callbackUrl = http://<zeppelin ip>:8080/api/callback
#clients.clients = $oidcClient
#requireRoleAdmin = org.pac4j.core.authorization.authorizer.RequireAnyRoleAuthorizer
#requireRoleAdmin.elements = <your role>
#config = org.pac4j.core.config.Config
#config.clients = $clients
#config.authorizers = admin:$requireRoleAdmin
#pac4jRealm = io.buji.pac4j.realm.Pac4jRealm
#pac4jSubjectFactory = io.buji.pac4j.subject.Pac4jSubjectFactory
#securityManager.subjectFactory = $pac4jSubjectFactory
#oidcSecurityFilter = io.buji.pac4j.filter.SecurityFilter
#oidcSecurityFilter.config = $config
#oidcSecurityFilter.clients = oidcClient
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you describe how to use this in https://github.com/apache/zeppelin/blob/master/docs/security/shiroauthentication.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to make some explanations in the docs, the fact is that both pac4j and buji are really highly configurable and most of configuration is provider dependent, this in theory result in free other integrations done by just changing shiro.ini but I'm not such an expert ...

#callbackFilter = io.buji.pac4j.filter.CallbackFilter
#callbackFilter.defaultUrl = http://<zeppelin ip>:8080
#callbackFilter.config = $config

Copy link
Contributor

@khalidhuseynov khalidhuseynov Jun 1, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think we'll need something like #securityManager.realms = $pac4jRealm here, isn't it?


sessionManager = org.apache.shiro.web.session.mgt.DefaultWebSessionManager

### If caching of user is required then uncomment below lines
Expand Down Expand Up @@ -82,5 +109,6 @@ admin = *
#/api/interpreter/** = authc, roles[admin]
#/api/configurations/** = authc, roles[admin]
#/api/credential/** = authc, roles[admin]
#/api/callback = callbackFilter
#/** = anon
/** = authc
39 changes: 36 additions & 3 deletions docs/security/shiroauthentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,12 @@ ldapRealm.contextFactory.authenticationMechanism = simple
```

### PAM
[PAM](https://en.wikipedia.org/wiki/Pluggable_authentication_module) authentication support allows the reuse of existing authentication
[PAM](https://en.wikipedia.org/wiki/Pluggable_authentication_module) authentication support allows the reuse of existing authentication
moduls on the host where Zeppelin is running. On a typical system modules are configured per service for example sshd, passwd, etc. under `/etc/pam.d/`. You can
either reuse one of these services or create your own for Zeppelin. Activiting PAM authentication requires two parameters:
1. realm: The Shiro realm being used
2. service: The service configured under `/etc/pam.d/` to be used. The name here needs to be the same as the file name under `/etc/pam.d/`

```
[main]
pamRealm=org.apache.zeppelin.realm.PamRealm
Expand All @@ -165,6 +165,40 @@ securityManager.realms = $zeppelinHubRealm

> Note: ZeppelinHub is not releated to Apache Zeppelin project.

### OpenID Connect
OpenID Connect enable you to integrate Zeppelin login with several providers(Google, AzureAD, Okta, IdentityServer3 (and 4), MitreID, Keycloak...).

Support is provided by the use of: [Pac4j-oidc](http://www.pac4j.org/docs/clients/openid-connect.html) and [Buji-pac4j](https://github.com/bujiio/buji-pac4j).

Specific configuration is strictly related to the provider, you need to configure the oidcClient to redirect you to the provider login page, handle the redirection back through the callback filter and add a SecurityFilter to check validity of the token.
More configuration parameters are available through [Buji-pac4j](https://github.com/bujiio/buji-pac4j) documentation.

```
### A sample for configuring Open ID Connect integration
oidcConfig = org.pac4j.oidc.config.OidcConfiguration
oidcConfig.discoveryURI = <your-instance>/realms/<your-realm>/.well-known/openid-configuration
oidcConfig.clientId = <your client name>
oidcConfig.secret = <your secret>
oidcConfig.clientAuthenticationMethodAsString = client_secret_basic
oidcClient = org.pac4j.oidc.client.OidcClient
oidcClient.configuration = $oidcConfig
oidcSecurityFilter = io.buji.pac4j.filter.SecurityFilter
oidcSecurityFilter.config = $config
oidcSecurityFilter.clients = oidcClient

clients = org.pac4j.core.client.Clients
clients.callbackUrl = http://<zeppelin ip>:8080/api/callback
clients.clients = $oidcClient

callbackFilter = io.buji.pac4j.filter.CallbackFilter
callbackFilter.defaultUrl = http://<zeppelin ip>:8080
callbackFilter.config = $config

##add this route to urls
[urls]
/api/callback = callbackFilter
```

## Secure your Zeppelin information (optional)
By default, anyone who defined in `[users]` can share **Interpreter Setting**, **Credential** and **Configuration** information in Apache Zeppelin.
Sometimes you might want to hide these information for your use case.
Expand All @@ -188,4 +222,3 @@ If you want to grant this permission to other users, you can change **roles[ ]**
## Other authentication methods

- [HTTP Basic Authentication using NGINX](./authentication.html)

201 changes: 201 additions & 0 deletions licenses/LICENSE-pac4j-1.9.8
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
4 changes: 3 additions & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,9 @@
<commons.io.version>2.4</commons.io.version>
<commons.collections.version>3.2.1</commons.collections.version>
<commons.logging.version>1.1.1</commons.logging.version>
<shiro.version>1.2.3</shiro.version>
<shiro.version>1.3.2</shiro.version>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also update shiro version in zeppelin-distribution/src/bin-license/LICENSE?

<pac4j.version>1.9.8</pac4j.version>
<buji.version>2.2.0</buji.version>

<!-- test library versions -->
<junit.version>4.12</junit.version>
Expand Down
32 changes: 31 additions & 1 deletion zeppelin-server/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,36 @@
<artifactId>shiro-web</artifactId>
</dependency>

<dependency>
<groupId>io.buji</groupId>
<artifactId>buji-pac4j</artifactId>
<version>${buji.version}</version>
<exclusions>
<exclusion>
<groupId>org.pac4j</groupId>
<artifactId>pac4j-core</artifactId>
</exclusion>
</exclusions>
</dependency>

<dependency>
<groupId>org.pac4j</groupId>
<artifactId>pac4j-core</artifactId>
<version>${pac4j.version}</version>
</dependency>

<dependency>
<groupId>org.pac4j</groupId>
<artifactId>pac4j-oidc</artifactId>
<version>${pac4j.version}</version>
<exclusions>
<exclusion>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
</exclusion>
</exclusions>
</dependency>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you add to the LICENSE file on these dependencies?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added license for pac4j, buji is again with Apache 2 shoul I add a specific file also for that one?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need to list license of those dependencies in zeppelin-distribution/src/bin-license/LICENSE file.
licenses/LICENSE-pac4j-1.9.8 also need to be moved to zeppelin-distribution/src/bin-license/licenses while those dependency will be included in binary package only.

pac4j-oidc brings some transitive dependencies. License of those dependencies also need to be taken care.

[INFO] +- org.pac4j:pac4j-oidc:jar:1.9.8:compile
[INFO] |  +- com.nimbusds:oauth2-oidc-sdk:jar:5.24.2:compile
[INFO] |  |  +- javax.mail:mail:jar:1.4.7:compile
[INFO] |  |  |  \- javax.activation:activation:jar:1.1:compile
[INFO] |  |  +- com.github.stephenc.jcip:jcip-annotations:jar:1.0-1:compile
[INFO] |  |  +- org.apache.commons:commons-collections4:jar:4.1:compile
[INFO] |  |  +- net.minidev:json-smart:jar:1.3.1:compile
[INFO] |  |  \- com.nimbusds:lang-tag:jar:1.4.3:compile (version selected from constraint [1.4.3,))
[INFO] |  \- com.nimbusds:nimbus-jose-jwt:jar:4.26:compile


<dependency>
<groupId>org.kohsuke</groupId>
<artifactId>libpam4j</artifactId>
Expand Down Expand Up @@ -487,7 +517,7 @@
</dependencies>
</dependencyManagement>
</profile>

<profile>
<id>using-source-tree</id>
<activation>
Expand Down
Loading