Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gjbae1212/gossm
💻Interactive CLI tool that you can connect to ec2 using commands same as start-session, ssh in AWS SSM Session Manager
https://github.com/gjbae1212/gossm
aws aws-ssm-agent cli ec2 go golang session-manager ssh tool
Last synced: 3 days ago
JSON representation
💻Interactive CLI tool that you can connect to ec2 using commands same as start-session, ssh in AWS SSM Session Manager
- Host: GitHub
- URL: https://github.com/gjbae1212/gossm
- Owner: gjbae1212
- License: mit
- Created: 2019-07-07T13:33:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T13:37:35.000Z (9 months ago)
- Last Synced: 2024-12-15T05:08:19.328Z (10 days ago)
- Topics: aws, aws-ssm-agent, cli, ec2, go, golang, session-manager, ssh, tool
- Language: Go
- Homepage:
- Size: 100 MB
- Stars: 425
- Watchers: 9
- Forks: 51
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gossm
`gossm` is interactive CLI tool that you should select server in AWS and then could connect or send files your AWS server using start-session, ssh, scp under AWS Systems Manger Session Manager.
## Overview
`gossm` is interactive CLI tool that is related AWS Systems Manger Session Manager.
It can select a ec2 server installed aws-ssm-agent and then can connect its server using start-session, ssh.
As well as files can send using scp.
If you will use `gossm` tool, this mean there will no need to open inbound 22 port in your ec2 server when is using ssh or scp command.
Because AWS Systems Manger Session Manager is using ssh protocol tunneling.
**Additionally Features**
- `mfa` command has added. this command is to authenticate through AWS MFA, and then to save issued a temporary credentials in $HOME/.aws/credentials_mfa. (default expired time is after 6 hours)
You should export global environment, such as `export AWS_SHARED_CREDENTIALS_FILE=$HOME/.aws/credentials_mfa`.
With completed, you can execute AWS CLI and gossm conveniently without mfa authenticated.
Refer to detail information below.
## Prerequisite
### ec2
- [required] Your ec2 servers in aws are installed [aws ssm agent](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html).
- [required] ec2 severs have to attach **AmazonSSMManagedInstanceCore** iam policy.
- If you would like to use ssh, scp command using gossm, aws ssm agent version **2.3.672.0 or later** is installed on ec2.
### user
- [required] your **aws access key**, **aws secret key**
- [required] **ec2:DescribeInstances**, **ssm:StartSession**, **ssm:TerminateSession**, **ssm:DescribeSessions**, **ssm:DescribeInstanceInformation**, **ssm:DescribeInstanceProperties**, **ssm:GetConnectionStatus**
- [optional] It's better to possibly get to additional permission for **ec2:DescribeRegions**
## Install
### Homebrew
```
# install
$ brew tap gjbae1212/gossm
$ brew install gossm
# upgrade
$ brew upgrade gossm
```
### Download
[download](https://github.com/gjbae1212/gossm/releases)
## How to use
### global command args
| args | Description | Default |
| ---------------|-----------------------------------------------------------|------------------------|
| -c | (optional) aws credentials file | $HOME/.aws/credentials |
| -p | (optional) if you are having multiple aws profiles in credentials, it is name one of profiles | default |
| -r | (optional) region in AWS that would like to connect | |
If your machine don't exist $HOME/.aws/.credentials, have to pass `-c` args.
```
# credentials file format
[default]
aws_access_key_id = AWS ACCESS KEY
aws_secret_access_key = AWS SECRET KEY
```
`-r` or `-t` don't pass args, it can select through interactive CLI.
### command
#### start
```bash
$ gossm start
```
#### ssh, scp
`-e` must pass args when is using scp.
`-e` args is command and args when usually used to pass ssh or scp.
```bash
# ssh(if pem is already registered using ssh-add)
$ gossm ssh -e 'user@server-domain'
# ssh(if pem isn't registered)
$ gossm ssh -e '-i key.pem user@server-domain'
# ssh(if pem is already registered using ssh-add and don't pass -e option) -> select server using interactive cli
$ gossm ssh
# ssh(if pem isn't registered and don't pass -e option) -> select server using interactive cli
$ gossm ssh -i key.pem
# scp(if pem is already registered using ssh-add)
$ gossm scp -e 'file user@server-domain:/home/blahblah'
# scp(if pem isn't registered)
$ gossm scp -e '-i key.pem file user@server-domain:/home/blahblah'
```
**ex)**
#### cmd
`-e` required args, it is a parameter for execute to command on selected servers.
```bash
# It is to execute a command("uptime") on selected multiple servers, waiting for a response on its result.
$ gossm cmd -e "uptime"
```
#### fwd
`-z` Optionally specify the remote port to access
`-l` Optionally specify the local port to forward (If not specified when using `-z`, then this value defaults to the value of `-z`)
```bash
$ gossm fwd -z 8080 -l 42069
```
If not specified, you will be prompted to enter a remote and local port after selecting a target.
#### mfa
`-deadline` it's to set expire time for temporary credentials. **default** is 6 hours.
`-device` it's to set mfa device. **default** is your virtual mfa device.
```bash
$ gossm mfa
```
**Must set to `export AWS_SHARED_CREDENTIALS_FILE=$HOME/.aws/credentials_mfa` in .bash_profile, .zshrc.**
**ex)**
## LICENSE
This project is following The MIT.