github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-29 01:44:36 -04:00
Code Issues Projects Releases Packages Wiki Activity

improve plugin author documentation

Browse source
This commit is contained in:
Robert Muir 2015-10-14 12:56:04 -04:00
parent 6e6c2bfda6
commit 2f168b8038
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/plugins/authors.asciidoc
View file

@ -124,8 +124,10 @@ Read more in {ref}/integration-tests.html#changing-node-configuration[Changing N
Some plugins may need additional security permissions. A plugin can include Some plugins may need additional security permissions. A plugin can include
the optional `plugin-security.policy` file containing `grant` statements for the optional `plugin-security.policy` file containing `grant` statements for
additional permissions. These permissions will be displayed to the user and additional permissions. Any additional permissions will be displayed to the user
they will have to confirm them when installing the plugin interactively. with a large warning, and they will have to confirm them when installing the
plugin interactively. So if possible, it is best to avoid requesting any
spurious permissions!
If you are using the elasticsearch Maven build system, place this file in If you are using the elasticsearch Maven build system, place this file in
`src/main/plugin-metadata` and it will be applied during unit tests as well. `src/main/plugin-metadata` and it will be applied during unit tests as well.
@ -138,6 +140,9 @@ from gaining escalated permissions. For example:
[source,java] [source,java]
-------------------------------------------------- --------------------------------------------------
// ES permission you should check before doPrivileged() blocks
import org.elasticsearch.SpecialPermission;
SecurityManager sm = System.getSecurityManager(); SecurityManager sm = System.getSecurityManager();
if (sm != null) { if (sm != null) {
// unprivileged code such as scripts do not have SpecialPermission // unprivileged code such as scripts do not have SpecialPermission