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.
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
Enable securitymanager #10717
Enable securitymanager #10717
Changes from 10 commits
270cb9f
7b6e470
0865d22
ffd8db6
e2861bd
573e81d
5d2153f
b2850bf
500c956
de109bd
2d778df
fca05ed
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,7 +26,6 @@ | |
import org.elasticsearch.common.collect.Tuple; | ||
import org.elasticsearch.common.inject.CreationException; | ||
import org.elasticsearch.common.inject.spi.Message; | ||
import org.elasticsearch.common.io.FileSystemUtils; | ||
import org.elasticsearch.common.io.PathUtils; | ||
import org.elasticsearch.common.jna.Natives; | ||
import org.elasticsearch.common.logging.ESLogger; | ||
|
@@ -40,7 +39,6 @@ | |
import org.elasticsearch.node.NodeBuilder; | ||
import org.elasticsearch.node.internal.InternalSettingsPreparer; | ||
|
||
import java.nio.file.Paths; | ||
import java.util.Locale; | ||
import java.util.Set; | ||
import java.util.concurrent.CountDownLatch; | ||
|
@@ -61,6 +59,7 @@ public class Bootstrap { | |
private static Bootstrap bootstrap; | ||
|
||
private void setup(boolean addShutdownHook, Tuple<Settings, Environment> tuple) throws Exception { | ||
setupSecurity(tuple.v1(), tuple.v2()); | ||
if (tuple.v1().getAsBoolean("bootstrap.mlockall", false)) { | ||
Natives.tryMlockall(); | ||
} | ||
|
@@ -92,6 +91,12 @@ public boolean handle(int code) { | |
}); | ||
} | ||
} | ||
|
||
private void setupSecurity(Settings settings, Environment environment) throws Exception { | ||
if (settings.getAsBoolean("security.manager.enabled", true)) { | ||
Security.configure(environment); | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can we debug log the default? also leaning to have info the "non default" setting, thats what we try to do most times in other components to try and keep the startup logs clean and informative. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is officially back and forth at this point. I started at info and went to warn based on feedback. Guys get your shit together, im not playing this game. |
||
} | ||
|
||
@SuppressForbidden(reason = "Exception#printStackTrace()") | ||
private static void setupLogging(Tuple<Settings, Environment> tuple) { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,143 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch 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.elasticsearch.bootstrap; | ||
|
||
import com.google.common.io.ByteStreams; | ||
|
||
import org.apache.lucene.util.IOUtils; | ||
import org.apache.lucene.util.StringHelper; | ||
import org.elasticsearch.env.Environment; | ||
|
||
import java.io.BufferedInputStream; | ||
import java.io.BufferedOutputStream; | ||
import java.io.ByteArrayOutputStream; | ||
import java.io.IOException; | ||
import java.io.InputStream; | ||
import java.io.OutputStream; | ||
import java.io.OutputStreamWriter; | ||
import java.io.Writer; | ||
import java.nio.charset.StandardCharsets; | ||
import java.nio.file.Files; | ||
import java.nio.file.NoSuchFileException; | ||
import java.nio.file.Path; | ||
import java.util.HashSet; | ||
import java.util.Set; | ||
|
||
/** | ||
* Initializes securitymanager with necessary permissions. | ||
* <p> | ||
* We use a template file (the one we test with), and add additional | ||
* permissions based on the environment (data paths, etc) | ||
*/ | ||
class Security { | ||
|
||
/** template policy file, the one used in tests */ | ||
static final String POLICY_RESOURCE = "security.policy"; | ||
|
||
/** | ||
* Initializes securitymanager for the environment | ||
* Can only happen once! | ||
*/ | ||
static void configure(Environment environment) throws IOException { | ||
// init lucene random seed. it will use /dev/urandom where available. | ||
StringHelper.randomId(); | ||
InputStream config = Security.class.getResourceAsStream(POLICY_RESOURCE); | ||
if (config == null) { | ||
throw new NoSuchFileException(POLICY_RESOURCE); | ||
} | ||
Path newConfig = processTemplate(config, environment); | ||
System.setProperty("java.security.policy", newConfig.toString()); | ||
System.setSecurityManager(new SecurityManager()); | ||
IOUtils.deleteFilesIgnoringExceptions(newConfig); // TODO: maybe log something if it fails? | ||
} | ||
|
||
// package-private for testing | ||
static Path processTemplate(InputStream template, Environment environment) throws IOException { | ||
Path processed = Files.createTempFile(null, null); | ||
try (OutputStream output = new BufferedOutputStream(Files.newOutputStream(processed))) { | ||
// copy the template as-is. | ||
try (InputStream in = new BufferedInputStream(template)) { | ||
ByteStreams.copy(in, output); | ||
} | ||
|
||
// add permissions for all configured paths. | ||
Set<Path> paths = new HashSet<>(); | ||
paths.add(environment.homeFile()); | ||
paths.add(environment.configFile()); | ||
paths.add(environment.logsFile()); | ||
paths.add(environment.pluginsFile()); | ||
paths.add(environment.workFile()); | ||
paths.add(environment.workWithClusterFile()); | ||
for (Path path : environment.dataFiles()) { | ||
paths.add(path); | ||
} | ||
for (Path path : environment.dataWithClusterFiles()) { | ||
paths.add(path); | ||
} | ||
output.write(createPermissions(paths)); | ||
} | ||
return processed; | ||
} | ||
|
||
// package private for testing | ||
static byte[] createPermissions(Set<Path> paths) throws IOException { | ||
ByteArrayOutputStream stream = new ByteArrayOutputStream(); | ||
|
||
// all policy files are UTF-8: | ||
// https://docs.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html | ||
try (Writer writer = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) { | ||
writer.write(System.lineSeparator()); | ||
writer.write("grant {"); | ||
writer.write(System.lineSeparator()); | ||
for (Path path : paths) { | ||
// data paths actually may not exist yet. | ||
Files.createDirectories(path); | ||
// add each path twice: once for itself, again for files underneath it | ||
addPath(writer, encode(path), "read,readlink,write,delete"); | ||
addRecursivePath(writer, encode(path), "read,readlink,write,delete"); | ||
} | ||
writer.write("};"); | ||
writer.write(System.lineSeparator()); | ||
} | ||
|
||
return stream.toByteArray(); | ||
} | ||
|
||
static void addPath(Writer writer, String path, String permissions) throws IOException { | ||
writer.write("permission java.io.FilePermission \"" + path + "\", \"" + permissions + "\";"); | ||
writer.write(System.lineSeparator()); | ||
} | ||
|
||
static void addRecursivePath(Writer writer, String path, String permissions) throws IOException { | ||
writer.write("permission java.io.FilePermission \"" + path + "${/}-\", \"" + permissions + "\";"); | ||
writer.write(System.lineSeparator()); | ||
} | ||
|
||
// Any backslashes in paths must be escaped, because it is the escape character when parsing. | ||
// See "Note Regarding File Path Specifications on Windows Systems". | ||
// https://docs.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html | ||
static String encode(Path path) { | ||
return encode(path.toString()); | ||
} | ||
|
||
static String encode(String path) { | ||
return path.replace("\\", "\\\\"); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch 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.elasticsearch.bootstrap; | ||
|
||
import org.elasticsearch.test.ElasticsearchTestCase; | ||
|
||
import java.nio.charset.StandardCharsets; | ||
import java.nio.file.Path; | ||
import java.util.Collections; | ||
|
||
public class SecurityTests extends ElasticsearchTestCase { | ||
|
||
/** backslash escaping (e.g. windows paths) */ | ||
public void testEncode() { | ||
assertEquals("c:\\\\foobar", Security.encode("c:\\foobar")); | ||
} | ||
|
||
/** test template processing */ | ||
public void testTemplateProcessing() throws Exception { | ||
Path path = createTempDir(); | ||
|
||
byte results[] = Security.createPermissions(Collections.singleton(path)); | ||
String unicode = new String(results, StandardCharsets.UTF_8); | ||
// try not to make this test too fragile or useless | ||
assertTrue(unicode.contains("grant {")); | ||
assertTrue(unicode.contains(Security.encode(path))); | ||
assertTrue(unicode.contains("read")); | ||
assertTrue(unicode.contains("write")); | ||
} | ||
|
||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we make
"security.manager.enabled"
a constant pleaseThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is a constant. Just like all the other strings in this file :)
So I will add it, but I will do so under protest:
In general, named constants considered harmful.