/
SshShellProperties.java
168 lines (122 loc) · 5.96 KB
/
SshShellProperties.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
* Copyright (c) 2020 François Onimus
*
* 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.
*/
package com.github.fonimus.ssh.shell;
import com.github.fonimus.ssh.shell.commands.CommandProperties;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.NestedConfigurationProperty;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;
import org.springframework.validation.annotation.Validated;
import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import static com.github.fonimus.ssh.shell.SshShellProperties.SSH_SHELL_PREFIX;
import static com.github.fonimus.ssh.shell.commands.DatasourceCommand.COMMAND_DATA_SOURCE_UPDATE;
/**
* Ssh shell properties (prefix : {@link SshShellProperties#SSH_SHELL_PREFIX})
*/
@Data
@ConfigurationProperties(prefix = SSH_SHELL_PREFIX)
@Validated
public class SshShellProperties {
public static final String SSH_SHELL_PREFIX = "ssh.shell";
public static final String SSH_SHELL_ENABLE = SSH_SHELL_PREFIX + ".enable";
public static final String DISABLE_SSH_SHELL = SSH_SHELL_ENABLE + "=false";
public static final String SPRING_SHELL_AUTO_CONFIG_CLASSES = "org.springframework.shell.boot.ExitCodeAutoConfiguration," +
"org.springframework.shell.boot.ShellContextAutoConfiguration," +
"org.springframework.shell.boot.SpringShellAutoConfiguration," +
"org.springframework.shell.boot.ShellRunnerAutoConfiguration," +
"org.springframework.shell.boot.ApplicationRunnerAutoConfiguration," +
"org.springframework.shell.boot.CommandCatalogAutoConfiguration," +
"org.springframework.shell.boot.LineReaderAutoConfiguration," +
"org.springframework.shell.boot.CompleterAutoConfiguration," +
"org.springframework.shell.boot.UserConfigAutoConfiguration," +
"org.springframework.shell.boot.JLineAutoConfiguration," +
"org.springframework.shell.boot.JLineShellAutoConfiguration," +
"org.springframework.shell.boot.ParameterResolverAutoConfiguration," +
"org.springframework.shell.boot.StandardAPIAutoConfiguration," +
"org.springframework.shell.boot.ThemingAutoConfiguration," +
"org.springframework.shell.boot.StandardCommandsAutoConfiguration," +
"org.springframework.shell.boot.ComponentFlowAutoConfiguration";
public static final String DISABLE_SPRING_SHELL_AUTO_CONFIG =
"spring.autoconfigure.exclude=" + SPRING_SHELL_AUTO_CONFIG_CLASSES;
public static final String ACTUATOR_ROLE = "ACTUATOR";
public static final String ADMIN_ROLE = "ADMIN";
private boolean enable = true;
private String host = "127.0.0.1";
private int port = 2222;
private String user = "user";
private String password;
private boolean displayBanner = true;
private AuthenticationType authentication = AuthenticationType.simple;
private String authProviderBeanName;
private File hostKeyFile = new File(System.getProperty("java.io.tmpdir"), "hostKey.ser");
private Resource authorizedPublicKeys;
private File historyFile = new File(System.getProperty("java.io.tmpdir"), "sshShellHistory.log");
private boolean sharedHistory = true;
/**
* Note: only used if @link {@link SshShellProperties#sharedHistory}} set to false
*/
private File historyDirectory = new File(System.getProperty("java.io.tmpdir"));
private List<String> confirmationWords = new ArrayList<>(SshShellHelper.DEFAULT_CONFIRM_WORDS);
/**
* Authentication type
*/
public enum AuthenticationType {
simple, security
}
private Prompt prompt = new Prompt();
private Commands commands = new Commands();
public void setAuthorizedPublicKeysFile(File file) {
this.authorizedPublicKeys = new FileSystemResource(file);
}
/**
* Prompt configuration
*/
@Data
public static class Prompt {
private String text = "shell>";
private PromptColor color = PromptColor.WHITE;
}
/**
* Commands configuration
*/
@Data
public static class Commands {
@NestedConfigurationProperty
private CommandProperties actuator = CommandProperties.withAuthorizedRoles(new ArrayList<>(Collections.singletonList(ACTUATOR_ROLE)));
@NestedConfigurationProperty
private CommandProperties jmx = new CommandProperties();
@NestedConfigurationProperty
private CommandProperties system = new CommandProperties();
@NestedConfigurationProperty
private CommandProperties tasks = new CommandProperties();
@NestedConfigurationProperty
private CommandProperties script = new CommandProperties();
@NestedConfigurationProperty
private CommandProperties history = new CommandProperties();
@NestedConfigurationProperty
private CommandProperties stacktrace = new CommandProperties();
@NestedConfigurationProperty
private CommandProperties datasource = CommandProperties.withExcludedByDefault(new ArrayList<>(Collections.singletonList(COMMAND_DATA_SOURCE_UPDATE)));
@NestedConfigurationProperty
private CommandProperties postprocessors = CommandProperties.notRestrictedByDefault();
@NestedConfigurationProperty
private CommandProperties manageSessions = CommandProperties.disabledByDefault();
}
}