How to use Kerberos authentication with WinRM for Go?

Use the TransportDecorator with ClientKerberos struct, specifying parameters like username, password, realm, and KrbConf file as shown in the README. Ensure the remote Windows host is configured for Kerberos with AllowUnencrypted settings.

WinRM for Go vs PowerShell Remoting – which is better for automation?

WinRM for Go is a library for building custom Go applications, offering programmatic control, while PowerShell Remoting is native to Windows and better for script-based automation. Choose based on your toolchain; WinRM for Go integrates well into Go ecosystems.

How to handle timeouts and cancellation in WinRM for Go?

Use context.WithTimeout or similar with RunWithContext methods; the library supports Go's context package to abort commands on the remote machine, but note that HTTP request cancellation may not be immediate.

Can WinRM for Go work through an SSH tunnel?

Yes, by setting a custom Dial function in parameters, such as using ssh.Client.Dial, as demonstrated in the README example for tunneling to other hosts securely.

Is WinRM for Go secure for production use with HTTPS?

It supports TLS and client certificate authentication, but the README examples often use AllowUnencrypted='true' for simplicity. Always configure encrypted connections and valid certificates to avoid security risks in production.

How to install the command-line tool for WinRM?

The CLI tool is split into a separate project at winrm-cli; this library is for programmatic use. Install it from the linked GitHub repository for standalone command execution.

Open-Awesome

winrm

Apache-2.0Go

A Go library and CLI tool for executing remote commands on Windows machines via WinRM/WinRS protocol.

GitHub

469 stars140 forks0 contributors

What is winrm?

WinRM for Go is a library and command-line tool that enables remote command execution on Windows machines using the WinRM/WinRS protocol. It allows developers to programmatically run commands on Windows servers from Go applications, solving the problem of automating Windows server management in cloud environments and infrastructure-as-code workflows.

Target Audience

Go developers building automation tools, DevOps engineers managing Windows servers in cloud environments (especially EC2), and infrastructure teams needing remote Windows administration capabilities.

Value Proposition

Developers choose WinRM for Go because it provides a pure-Go implementation of WinRM with flexible authentication (Basic, NTLM, Kerberos), extensible transport layers, and no external C dependencies, making it ideal for cross-platform automation tools that need to manage Windows infrastructure.

Overview

Command-line tool and library for Windows remote command execution in Go

Use Cases

Best For

Automating Windows server management in Go applications
Running remote commands on EC2 Windows instances
Building infrastructure-as-code tools for Windows environments
Creating cross-platform administration tools that include Windows support
Integrating Windows server management into DevOps pipelines
Developing custom Windows remote administration utilities

Not Ideal For

Projects requiring seamless Active Directory domain user authentication with full GSSAPI support
Environments where Windows servers are not pre-configured for WinRM with Basic or Kerberos auth
Applications needing real-time, interactive shell sessions with low latency over native protocols like SSH

Pros & Cons

Pros

Pure Go Implementation

No external C dependencies like libxml, making it cross-platform and easy to deploy in Go-based automation tools without runtime issues.

Flexible Authentication Options

Supports Basic, NTLM, and Kerberos authentication with pluggable models, as shown in README examples for Azure VMs and domain accounts.

Extensible Transport Layer

Allows custom transports such as SSH tunneling or custom HTTP clients via TransportDecorator, enabling secure connections through proxies or indirect routes.

Context Integration

Uses Go's context package for command cancellation and timeouts, providing better control over remote execution flows in concurrent applications.

Cons

Complex Remote Configuration

Requires manual PowerShell commands run as administrator on Windows machines to enable WinRM and set authentication, which is error-prone and not automated.

Confusing Domain Support

README initially states no support for domain users or Kerberos, but later includes Kerberos examples, indicating inconsistent documentation or partial feature implementation.

API Stability Risks

The library usage section warns that the API might be subject to change, posing maintenance challenges for production code relying on current interfaces.

Frequently Asked Questions

Related Projects

fasthttp

Fast HTTP package for Go. Tuned for high performance. Zero memory allocations in hot paths. Up to 10x faster than net/http

Stars23,351

Forks1,817

Last commit18 hours ago

webrtc

Pure Go implementation of the WebRTC API

Stars16,459

Forks1,842

Last commit2 days ago

kcptun

Reliable UDP Transmission Optimizer based on KCP: Enhancing network efficiency in poor connectivity environments.

Stars14,403

Forks2,631

Last commit1 month ago

cloudflared

Cloudflare Tunnel client

Stars14,214

Forks1,291

Last commit3 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub