forked from apache/zeppelin
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ZEPPELIN-1070] Inject Credentials in any Interpreter-Code
- Loading branch information
Showing
4 changed files
with
242 additions
and
7 deletions.
There are no files selected for viewing
98 changes: 98 additions & 0 deletions
98
zeppelin-zengine/src/main/java/org/apache/zeppelin/notebook/CredentialInjector.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,98 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. | ||
| */ | ||
| package org.apache.zeppelin.notebook; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.apache.zeppelin.interpreter.InterpreterResult; | ||
| import org.apache.zeppelin.interpreter.InterpreterResultMessage; | ||
| import org.apache.zeppelin.user.UserCredentials; | ||
| import org.apache.zeppelin.user.UsernamePassword; | ||
|
|
||
| /** | ||
| * Class for replacing $[user.>credentialkey<] and | ||
| * $[password.>credentialkey<] tags with the matching credentials from | ||
| * zeppelin | ||
| */ | ||
| class CredentialInjector { | ||
|
|
||
| private Set<String> passwords = new HashSet<>(); | ||
| private final UserCredentials creds; | ||
|
|
||
| public CredentialInjector(UserCredentials creds) { | ||
| this.creds = creds; | ||
| } | ||
|
|
||
| public String replaceCredentials(String code) { | ||
| if (code == null) { | ||
| return null; | ||
| } | ||
| String replaced = code; | ||
| Pattern userpattern = Pattern.compile("\\$\\[user\\.([^\\]]+)\\]"); | ||
| Pattern passwordpattern = Pattern.compile("\\$\\[password\\.([^\\]]+)\\]"); | ||
| Matcher matcher = userpattern.matcher(replaced); | ||
| while (matcher.find()) { | ||
| String key = matcher.group(1); | ||
| UsernamePassword usernamePassword = creds.getUsernamePassword(key); | ||
| String value = usernamePassword == null ? "undef" : usernamePassword.getUsername(); | ||
| replaced = matcher.replaceFirst(value); | ||
| matcher = userpattern.matcher(replaced); | ||
| } | ||
| matcher = passwordpattern.matcher(replaced); | ||
| while (matcher.find()) { | ||
| String key = matcher.group(1); | ||
| UsernamePassword usernamePassword = creds.getUsernamePassword(key); | ||
| if (usernamePassword != null) { | ||
| passwords.add(usernamePassword.getPassword()); | ||
| } | ||
| String value = usernamePassword == null ? "undef" : usernamePassword.getPassword(); | ||
| replaced = matcher.replaceFirst(value); | ||
| matcher = passwordpattern.matcher(replaced); | ||
| } | ||
| return replaced; | ||
| } | ||
|
|
||
| public InterpreterResult hidePasswords(InterpreterResult ret) { | ||
| if (ret == null) { | ||
| return null; | ||
| } | ||
| return new InterpreterResult(ret.code(), replacePasswords(ret.message())); | ||
| } | ||
|
|
||
| private List<InterpreterResultMessage> replacePasswords(List<InterpreterResultMessage> original) { | ||
| List<InterpreterResultMessage> replaced = new ArrayList<>(); | ||
| for (InterpreterResultMessage msg : original) { | ||
| String replacedMessages = replacePasswords(msg.getData()); | ||
| replaced.add(new InterpreterResultMessage(msg.getType(), replacedMessages)); | ||
| } | ||
| return replaced; | ||
| } | ||
|
|
||
| private String replacePasswords(String str) { | ||
| String result = str; | ||
| for (String password : passwords) { | ||
| result = result.replace(password, "###"); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| } |
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
88 changes: 88 additions & 0 deletions
88
zeppelin-zengine/src/test/java/org/apache/zeppelin/notebook/CredentialInjectorTest.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,88 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. | ||
| */ | ||
|
|
||
| package org.apache.zeppelin.notebook; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertNull; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import org.apache.zeppelin.interpreter.InterpreterResult; | ||
| import org.apache.zeppelin.interpreter.InterpreterResult.Code; | ||
| import org.apache.zeppelin.user.UserCredentials; | ||
| import org.apache.zeppelin.user.UsernamePassword; | ||
| import org.junit.Test; | ||
|
|
||
| public class CredentialInjectorTest { | ||
|
|
||
| private static final String TEMPLATE = | ||
| "val jdbcUrl = \"jdbc:mysql://localhost/emp?user=$[user.mysql]&password=$[password.mysql]\""; | ||
| private static final String CORRECT_REPLACED = | ||
| "val jdbcUrl = \"jdbc:mysql://localhost/emp?user=username&password=pwd\""; | ||
| private static final String NOT_REPLACED = | ||
| "val jdbcUrl = \"jdbc:mysql://localhost/emp?user=undef&password=undef\""; | ||
|
|
||
| private static final String ANSWER = | ||
| "jdbcUrl: String = jdbc:mysql://localhost/employees?user=username&password=pwd"; | ||
| private static final String HIDDEN = | ||
| "jdbcUrl: String = jdbc:mysql://localhost/employees?user=username&password=###"; | ||
|
|
||
| @Test | ||
| public void replaceCredentials() { | ||
| UserCredentials userCredentials = mock(UserCredentials.class); | ||
| UsernamePassword usernamePassword = new UsernamePassword("username", "pwd"); | ||
| when(userCredentials.getUsernamePassword("mysql")).thenReturn(usernamePassword); | ||
| CredentialInjector testee = new CredentialInjector(userCredentials); | ||
| String actual = testee.replaceCredentials(TEMPLATE); | ||
| assertEquals(CORRECT_REPLACED, actual); | ||
|
|
||
| InterpreterResult ret = new InterpreterResult(Code.SUCCESS, ANSWER); | ||
| InterpreterResult hiddenResult = testee.hidePasswords(ret); | ||
| assertEquals(1, hiddenResult.message().size()); | ||
| assertEquals(HIDDEN, hiddenResult.message().get(0).getData()); | ||
| } | ||
|
|
||
| @Test | ||
| public void replaceCredentialNoTexts() { | ||
| UserCredentials userCredentials = mock(UserCredentials.class); | ||
| CredentialInjector testee = new CredentialInjector(userCredentials); | ||
| String actual = testee.replaceCredentials(null); | ||
| assertNull(actual); | ||
| } | ||
|
|
||
| @Test | ||
| public void replaceCredentialsNotExisting() { | ||
| UserCredentials userCredentials = mock(UserCredentials.class); | ||
| CredentialInjector testee = new CredentialInjector(userCredentials); | ||
| String actual = testee.replaceCredentials(TEMPLATE); | ||
| assertEquals(NOT_REPLACED, actual); | ||
|
|
||
| InterpreterResult ret = new InterpreterResult(Code.SUCCESS, ANSWER); | ||
| InterpreterResult hiddenResult = testee.hidePasswords(ret); | ||
| assertEquals(1, hiddenResult.message().size()); | ||
| assertEquals(ANSWER, hiddenResult.message().get(0).getData()); | ||
| } | ||
|
|
||
| @Test | ||
| public void hidePasswordsNoResult() { | ||
| UserCredentials userCredentials = mock(UserCredentials.class); | ||
| CredentialInjector testee = new CredentialInjector(userCredentials); | ||
| assertNull(testee.hidePasswords(null)); | ||
| } | ||
|
|
||
| } |
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