README
¶
mcr
mcr is a dependency-free remote console (RCon) package written in Golang following the Source protocol.
Usage
import (
"log"
"os"
"github.com/jake-young-dev/mcr"
)
func main() {
//create new client to server address on port 9876
client := mcr.NewClient(os.Getenv("rcon_address"), mcr.WithPort(9876))
//connect to server and authenticate with password
err := client.Connect(os.Getenv("rcon_password"))
if err != nil {
panic(err)
}
defer client.Close() //always call close to clean up your connections
response, err := client.Command("list") //run "list" command on server
if err != nil {
panic(err)
}
log.Println(response)
}
Default Options
- Timeout is defaulted 10 seconds
- Port is defaulted to 61695
Security
- RCon is an inherently insecure protocol that sends passwords in plaintext. I recommend using a VPN or keeping the connection local when possible.
- All code is checked with gosec as an added security measure
Documentation
¶
Index ¶
Constants ¶
const ( //rcon packet type values FailurePacket = int32(-1) CommandPacket = int32(2) AuthPacket = int32(3) //tcp constants Protocol = "tcp" PacketRequestSize = 10 //size of headers plus padding bytes, not including Size header per RCon standard PacketHeaderSize = 8 //size of headers not including Size header per RCon standard PacketPaddingSize = 2 //size of padding required after body //default values ResetID = 1 DefaultCap = 100 DefaultTimeout = time.Second * 10 DefaultPort = 61695 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
remote console client
func NewClient ¶
creates a new remote console client configured with the supplied options. The client does not connect to the server until the Connect method is called to authenticate the client. Check the README for information on default values
func (*Client) Close ¶
closes remote console connection, nil's out the connection value in client struct, and resets the request id
func (*Client) Command ¶
sends a command to the server and returns the server response, an error is returned if the client has not connected to the server before attempting to send a command
func (*Client) CommandNoResponse ¶ added in v1.3.2
sends a command to the server without waiting for the response, an error is returned if the client has not connected to the server before attempting to send a command
type Option ¶ added in v0.2.0
type Option func(cn *Client)
request option func skeleton
func WithConnection ¶ added in v1.1.1
option to allow for use of custom connections
func WithTimeout ¶ added in v0.2.0
option to allow for custom timeout values
Source Files