2 Star 5 Fork 6

minbox-projects / ssh-agent

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ssh-agent

提供SSH代理跳板方式,支持 “用户名 + 公钥”、“用户名 + 密码方式” 认证登录,建立本地端口与远程端口通信管道。

如何使用?

ssh-agent依赖已经上传到Maven Central,不同构件环境使用方式不同。

Maven方式:

pom.xml文件内添加如下依赖:

<dependency>
  <groupId>org.minbox.framework</groupId>
  <artifactId>ssh-agent</artifactId>
  <version>1.0.2</version>
</dependency>

Gradle方式:

build.gradle文件内添加如下依赖:

implementation 'org.minbox.framework:ssh-agent:1.0.2'

在SpringBoot项目内使用

使用示例项目访问:api-boot-sample-ssh-agent

步骤一:添加依赖

pom.xml文件内添加api-boot-starter-ssh-agent依赖:

<dependency>
  <groupId>org.minbox.framework</groupId>
  <artifactId>api-boot-starter-ssh-agent</artifactId>
</dependency>

如果添加的依赖找不到或者无法下载,请访问官网快速开始:快速使用手册

步骤二:配置转发代理端口

application.yml配置文件内进行配置,可以通过结合spring profiles激活不同配置环境的代理方式

# ApiBoot相关配置
api:
  boot:
    # 配置连接生产环境的SSH Agent
    ssh-agent:
      configs:
        # 连接生产MySQL
        - username: metadata
          server-ip: xxx.xxx.xx.xx
          local-port: 3307
          forward-target-port: 3306
        # 连接生产Mongo
        - username: metadata
          server-ip: xxx.xxx.xx.xx
          local-port: 27018
          forward-target-ip: 192.168.1.220
          forward-target-port: 27017
        # 连接生产Redis
        - username: metadata
          server-ip: xxx.xxx.xx.xx
          local-port: 6378
          forward-target-port: 6379

注意事项:如果不通过username/password方式代理认证,需要在远程服务登录用户Home目录下~/.ssh/authorized_keys文件内添加本机的SSH 公钥。

在Junit5中使用

步骤一:继承SshAgentJunitTest单元测试类

@SpringBootTest
class SimulationServiceApiApplicationTests extends SshAgentJunitTest {
    @Test
    void contextLoads() {
        //...
    }
}

单元测试类继承自SshAgentJunitTest后就可以在测试方法执行前开启ssh代理连接,执行后关闭代理连接。

步骤二:添加ssh-agent.yml配置文件

ssh-agent.yml用于配置ssh代理连接列表,位于src/test/resources目录下,如果不创建该配置文件运行单元测试方法时会抛出异常。

configs:
  # 代理转发MySQL
  - username: developer
    serverIp: x.x.x.x
    localPort: 3306
    forwardTargetPort: 59500
  # 代理转发Redis
  - username: developer
    serverIp: x.x.x.x
    localPort: 6379
    forwardTargetPort: 59504
  # 代理转发mongo
  - username: developer
    serverIp: x.x.x.x
    localPort: 27017
    forwardTargetPort: 59503

为什么要用?

服务器的安全性、数据的安全性对于我们来说异常的重要,有时服务器的运维人员仅通过SSH PublicKey给我们开通权限,我们只能通过已授权的公钥访问服务器,这种方式安全系数比较高。

为了安全起见,服务器的防火墙一般不会直接开放服务端口(如:MySQL => 3306),加上运维人员是通过Public Key的方式给我们授权,那我们该怎么在本机访问远程的数据库呢?

如果是数据库图形界面工具(DataGrip、Navicat)很简单就可以连接,因为他们都提供了基于SSH的连接方式,那如果我们想在本地的项目中使用远程数据库呢?该怎么去做呢?

那么请尝试使用ssh-agent

ssh-agent所能代理的不仅仅是MySQL => 3306,是服务器本身上 + 可通信局域网服务器的全部端口号的服务,比如:Mongo => 27017、Redis => 6379等。

实现原理

ssh-agent是通过建立本机与远程服务器之间的端口转发的形式来做的,类似于Docker的宿主机容器之间的通信方式。

首先需要登录到远程的服务器,ssh-agent目前支持两种方式:

用户名密码方式: 默认通过22端口号,通过提供的服务器用户名、密码来建立有效的通信会话

用户秘钥方式: 默认通过22端口号,通过用户名以及当前用户home目录下的ssh private key文件来建立安全有效的通信会话(默认方式)。

登录成功后,会建立指定的本机端口号与远程服务器端口号的转发通信管道。

AgentConfig

AgentConfig类中定义了代理连接远程服务器的全部参数。

参数名 默认值 描述
authenticationMethod SSH_PRIVATE_KEY 登录服务器的授权方式,默认为private key方式
username - 登录服务器的用户名
password - 登录服务器的密码,仅在USERNAME_PASSWORD授权登录方式下有效
serverIp - 服务器IP地址
sshPort 22 SSH端口号,默认为22
sshPrivateKeyPath 当前用户home目录/.ssh/id_rsa 默认使用RSA方式的private key,如果本机通过其他加密方式生成ssh秘钥文件,请修改该参数(请配置文件绝对路径)。仅在SSH_PRIVATE_KEY授权登录方式下有效。
sshKnownHostsPath 当前用户home目录/known_hosts 已知的主机文件,仅在SSH_PRIVATE_KEY授权登录方式下有效。
localPort - 本地端口号,最大值:65535
forwardTargetPort - 转发的目标端口号,最大值:65535
forwardTargetIp 127.0.0.1 转发的目标IP地址,默认为:127.0.0.1(本机),如果需要通过局域网IP地址访问其他服务器需要进行修改
addition - 附加的配置参数集合,用于JSch Session#config方法

AgentConnection

AgentConnection是用于本机与远程服务器建立连接的核心类,需要通过AgentConfig对象实例进行初始化。

该接口提供了#connect#disconnect两个方法,默认的实现类为org.minbox.framework.ssh.agent.DefaultAgentConnection

Ssh Private Key连接示例:

/**
  * 使用ssh private key方式代理连接远程服务
  * <p>
  * 本地 "3307" 端口号绑定远程服务器 "3306"端口号,实现本地访问远程服务器上的MySQL服务
  */
static void sshPrivateConnect() {
  AgentConfig config2 = new AgentConfig();
  config2.setServerIp("xxx.xxx.xxx.xxx");
  config2.setUsername("root");
  config2.setLocalPort(3307);
  config2.setForwardTargetPort(3306);
  AgentConnection connection2 = new DefaultAgentConnection(config2);
  connection2.connect();
  // 连接成功后,访问本地3307的数据库,其实就是访问远程服务器的3306
}

用户名密码连接示例:

/**
  * 使用用户名密码方式代理连接远程服务
  * <p>
  * 本地 "3307" 端口号绑定远程服务器 "3306"端口号,实现本地访问远程服务器上的MySQL服务
  */
static void usernamePasswordConnect() {
  AgentConfig config = new AgentConfig();
  config.setServerIp("xxx.xxx.xxx.xxx");
  config.setUsername("root");
  config.setPassword("密码");
  config.setLocalPort(3307);
  config.setForwardTargetPort(3306);
  AgentConnection connection = new DefaultAgentConnection(config);
  connection.connect();
  // 连接成功后,访问本地3307的数据库,其实就是访问远程服务器的3306
}
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.

简介

SSH代理跳板方式,支持 “用户名 + 公钥”、“用户名 + 密码方式” 认证登录,建立本地端口与远程服务器端口之间的通信管道。 展开 收起
Java
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/minbox-projects/ssh-agent.git
git@gitee.com:minbox-projects/ssh-agent.git
minbox-projects
ssh-agent
ssh-agent
master

搜索帮助

14c37bed 8189591 565d56ea 8189591