vendor: remove github.com/hashicorp/scada-client
This commit is contained in:
parent
10b185a52c
commit
39aeb5e520
|
@ -1,363 +0,0 @@
|
|||
Mozilla Public License, version 2.0
|
||||
|
||||
1. Definitions
|
||||
|
||||
1.1. "Contributor"
|
||||
|
||||
means each individual or legal entity that creates, contributes to the
|
||||
creation of, or owns Covered Software.
|
||||
|
||||
1.2. "Contributor Version"
|
||||
|
||||
means the combination of the Contributions of others (if any) used by a
|
||||
Contributor and that particular Contributor's Contribution.
|
||||
|
||||
1.3. "Contribution"
|
||||
|
||||
means Covered Software of a particular Contributor.
|
||||
|
||||
1.4. "Covered Software"
|
||||
|
||||
means Source Code Form to which the initial Contributor has attached the
|
||||
notice in Exhibit A, the Executable Form of such Source Code Form, and
|
||||
Modifications of such Source Code Form, in each case including portions
|
||||
thereof.
|
||||
|
||||
1.5. "Incompatible With Secondary Licenses"
|
||||
means
|
||||
|
||||
a. that the initial Contributor has attached the notice described in
|
||||
Exhibit B to the Covered Software; or
|
||||
|
||||
b. that the Covered Software was made available under the terms of
|
||||
version 1.1 or earlier of the License, but not also under the terms of
|
||||
a Secondary License.
|
||||
|
||||
1.6. "Executable Form"
|
||||
|
||||
means any form of the work other than Source Code Form.
|
||||
|
||||
1.7. "Larger Work"
|
||||
|
||||
means a work that combines Covered Software with other material, in a
|
||||
separate file or files, that is not Covered Software.
|
||||
|
||||
1.8. "License"
|
||||
|
||||
means this document.
|
||||
|
||||
1.9. "Licensable"
|
||||
|
||||
means having the right to grant, to the maximum extent possible, whether
|
||||
at the time of the initial grant or subsequently, any and all of the
|
||||
rights conveyed by this License.
|
||||
|
||||
1.10. "Modifications"
|
||||
|
||||
means any of the following:
|
||||
|
||||
a. any file in Source Code Form that results from an addition to,
|
||||
deletion from, or modification of the contents of Covered Software; or
|
||||
|
||||
b. any new file in Source Code Form that contains any Covered Software.
|
||||
|
||||
1.11. "Patent Claims" of a Contributor
|
||||
|
||||
means any patent claim(s), including without limitation, method,
|
||||
process, and apparatus claims, in any patent Licensable by such
|
||||
Contributor that would be infringed, but for the grant of the License,
|
||||
by the making, using, selling, offering for sale, having made, import,
|
||||
or transfer of either its Contributions or its Contributor Version.
|
||||
|
||||
1.12. "Secondary License"
|
||||
|
||||
means either the GNU General Public License, Version 2.0, the GNU Lesser
|
||||
General Public License, Version 2.1, the GNU Affero General Public
|
||||
License, Version 3.0, or any later versions of those licenses.
|
||||
|
||||
1.13. "Source Code Form"
|
||||
|
||||
means the form of the work preferred for making modifications.
|
||||
|
||||
1.14. "You" (or "Your")
|
||||
|
||||
means an individual or a legal entity exercising rights under this
|
||||
License. For legal entities, "You" includes any entity that controls, is
|
||||
controlled by, or is under common control with You. For purposes of this
|
||||
definition, "control" means (a) the power, direct or indirect, to cause
|
||||
the direction or management of such entity, whether by contract or
|
||||
otherwise, or (b) ownership of more than fifty percent (50%) of the
|
||||
outstanding shares or beneficial ownership of such entity.
|
||||
|
||||
|
||||
2. License Grants and Conditions
|
||||
|
||||
2.1. Grants
|
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||
non-exclusive license:
|
||||
|
||||
a. under intellectual property rights (other than patent or trademark)
|
||||
Licensable by such Contributor to use, reproduce, make available,
|
||||
modify, display, perform, distribute, and otherwise exploit its
|
||||
Contributions, either on an unmodified basis, with Modifications, or
|
||||
as part of a Larger Work; and
|
||||
|
||||
b. under Patent Claims of such Contributor to make, use, sell, offer for
|
||||
sale, have made, import, and otherwise transfer either its
|
||||
Contributions or its Contributor Version.
|
||||
|
||||
2.2. Effective Date
|
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution
|
||||
become effective for each Contribution on the date the Contributor first
|
||||
distributes such Contribution.
|
||||
|
||||
2.3. Limitations on Grant Scope
|
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under
|
||||
this License. No additional rights or licenses will be implied from the
|
||||
distribution or licensing of Covered Software under this License.
|
||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||
Contributor:
|
||||
|
||||
a. for any code that a Contributor has removed from Covered Software; or
|
||||
|
||||
b. for infringements caused by: (i) Your and any other third party's
|
||||
modifications of Covered Software, or (ii) the combination of its
|
||||
Contributions with other software (except as part of its Contributor
|
||||
Version); or
|
||||
|
||||
c. under Patent Claims infringed by Covered Software in the absence of
|
||||
its Contributions.
|
||||
|
||||
This License does not grant any rights in the trademarks, service marks,
|
||||
or logos of any Contributor (except as may be necessary to comply with
|
||||
the notice requirements in Section 3.4).
|
||||
|
||||
2.4. Subsequent Licenses
|
||||
|
||||
No Contributor makes additional grants as a result of Your choice to
|
||||
distribute the Covered Software under a subsequent version of this
|
||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||
permitted under the terms of Section 3.3).
|
||||
|
||||
2.5. Representation
|
||||
|
||||
Each Contributor represents that the Contributor believes its
|
||||
Contributions are its original creation(s) or it has sufficient rights to
|
||||
grant the rights to its Contributions conveyed by this License.
|
||||
|
||||
2.6. Fair Use
|
||||
|
||||
This License is not intended to limit any rights You have under
|
||||
applicable copyright doctrines of fair use, fair dealing, or other
|
||||
equivalents.
|
||||
|
||||
2.7. Conditions
|
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
|
||||
Section 2.1.
|
||||
|
||||
|
||||
3. Responsibilities
|
||||
|
||||
3.1. Distribution of Source Form
|
||||
|
||||
All distribution of Covered Software in Source Code Form, including any
|
||||
Modifications that You create or to which You contribute, must be under
|
||||
the terms of this License. You must inform recipients that the Source
|
||||
Code Form of the Covered Software is governed by the terms of this
|
||||
License, and how they can obtain a copy of this License. You may not
|
||||
attempt to alter or restrict the recipients' rights in the Source Code
|
||||
Form.
|
||||
|
||||
3.2. Distribution of Executable Form
|
||||
|
||||
If You distribute Covered Software in Executable Form then:
|
||||
|
||||
a. such Covered Software must also be made available in Source Code Form,
|
||||
as described in Section 3.1, and You must inform recipients of the
|
||||
Executable Form how they can obtain a copy of such Source Code Form by
|
||||
reasonable means in a timely manner, at a charge no more than the cost
|
||||
of distribution to the recipient; and
|
||||
|
||||
b. You may distribute such Executable Form under the terms of this
|
||||
License, or sublicense it under different terms, provided that the
|
||||
license for the Executable Form does not attempt to limit or alter the
|
||||
recipients' rights in the Source Code Form under this License.
|
||||
|
||||
3.3. Distribution of a Larger Work
|
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice,
|
||||
provided that You also comply with the requirements of this License for
|
||||
the Covered Software. If the Larger Work is a combination of Covered
|
||||
Software with a work governed by one or more Secondary Licenses, and the
|
||||
Covered Software is not Incompatible With Secondary Licenses, this
|
||||
License permits You to additionally distribute such Covered Software
|
||||
under the terms of such Secondary License(s), so that the recipient of
|
||||
the Larger Work may, at their option, further distribute the Covered
|
||||
Software under the terms of either this License or such Secondary
|
||||
License(s).
|
||||
|
||||
3.4. Notices
|
||||
|
||||
You may not remove or alter the substance of any license notices
|
||||
(including copyright notices, patent notices, disclaimers of warranty, or
|
||||
limitations of liability) contained within the Source Code Form of the
|
||||
Covered Software, except that You may alter any license notices to the
|
||||
extent required to remedy known factual inaccuracies.
|
||||
|
||||
3.5. Application of Additional Terms
|
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support,
|
||||
indemnity or liability obligations to one or more recipients of Covered
|
||||
Software. However, You may do so only on Your own behalf, and not on
|
||||
behalf of any Contributor. You must make it absolutely clear that any
|
||||
such warranty, support, indemnity, or liability obligation is offered by
|
||||
You alone, and You hereby agree to indemnify every Contributor for any
|
||||
liability incurred by such Contributor as a result of warranty, support,
|
||||
indemnity or liability terms You offer. You may include additional
|
||||
disclaimers of warranty and limitations of liability specific to any
|
||||
jurisdiction.
|
||||
|
||||
4. Inability to Comply Due to Statute or Regulation
|
||||
|
||||
If it is impossible for You to comply with any of the terms of this License
|
||||
with respect to some or all of the Covered Software due to statute,
|
||||
judicial order, or regulation then You must: (a) comply with the terms of
|
||||
this License to the maximum extent possible; and (b) describe the
|
||||
limitations and the code they affect. Such description must be placed in a
|
||||
text file included with all distributions of the Covered Software under
|
||||
this License. Except to the extent prohibited by statute or regulation,
|
||||
such description must be sufficiently detailed for a recipient of ordinary
|
||||
skill to be able to understand it.
|
||||
|
||||
5. Termination
|
||||
|
||||
5.1. The rights granted under this License will terminate automatically if You
|
||||
fail to comply with any of its terms. However, if You become compliant,
|
||||
then the rights granted under this License from a particular Contributor
|
||||
are reinstated (a) provisionally, unless and until such Contributor
|
||||
explicitly and finally terminates Your grants, and (b) on an ongoing
|
||||
basis, if such Contributor fails to notify You of the non-compliance by
|
||||
some reasonable means prior to 60 days after You have come back into
|
||||
compliance. Moreover, Your grants from a particular Contributor are
|
||||
reinstated on an ongoing basis if such Contributor notifies You of the
|
||||
non-compliance by some reasonable means, this is the first time You have
|
||||
received notice of non-compliance with this License from such
|
||||
Contributor, and You become compliant prior to 30 days after Your receipt
|
||||
of the notice.
|
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent
|
||||
infringement claim (excluding declaratory judgment actions,
|
||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||
directly or indirectly infringes any patent, then the rights granted to
|
||||
You by any and all Contributors for the Covered Software under Section
|
||||
2.1 of this License shall terminate.
|
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
|
||||
license agreements (excluding distributors and resellers) which have been
|
||||
validly granted by You or Your distributors under this License prior to
|
||||
termination shall survive termination.
|
||||
|
||||
6. Disclaimer of Warranty
|
||||
|
||||
Covered Software is provided under this License on an "as is" basis,
|
||||
without warranty of any kind, either expressed, implied, or statutory,
|
||||
including, without limitation, warranties that the Covered Software is free
|
||||
of defects, merchantable, fit for a particular purpose or non-infringing.
|
||||
The entire risk as to the quality and performance of the Covered Software
|
||||
is with You. Should any Covered Software prove defective in any respect,
|
||||
You (not any Contributor) assume the cost of any necessary servicing,
|
||||
repair, or correction. This disclaimer of warranty constitutes an essential
|
||||
part of this License. No use of any Covered Software is authorized under
|
||||
this License except under this disclaimer.
|
||||
|
||||
7. Limitation of Liability
|
||||
|
||||
Under no circumstances and under no legal theory, whether tort (including
|
||||
negligence), contract, or otherwise, shall any Contributor, or anyone who
|
||||
distributes Covered Software as permitted above, be liable to You for any
|
||||
direct, indirect, special, incidental, or consequential damages of any
|
||||
character including, without limitation, damages for lost profits, loss of
|
||||
goodwill, work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses, even if such party shall have been
|
||||
informed of the possibility of such damages. This limitation of liability
|
||||
shall not apply to liability for death or personal injury resulting from
|
||||
such party's negligence to the extent applicable law prohibits such
|
||||
limitation. Some jurisdictions do not allow the exclusion or limitation of
|
||||
incidental or consequential damages, so this exclusion and limitation may
|
||||
not apply to You.
|
||||
|
||||
8. Litigation
|
||||
|
||||
Any litigation relating to this License may be brought only in the courts
|
||||
of a jurisdiction where the defendant maintains its principal place of
|
||||
business and such litigation shall be governed by laws of that
|
||||
jurisdiction, without reference to its conflict-of-law provisions. Nothing
|
||||
in this Section shall prevent a party's ability to bring cross-claims or
|
||||
counter-claims.
|
||||
|
||||
9. Miscellaneous
|
||||
|
||||
This License represents the complete agreement concerning the subject
|
||||
matter hereof. If any provision of this License is held to be
|
||||
unenforceable, such provision shall be reformed only to the extent
|
||||
necessary to make it enforceable. Any law or regulation which provides that
|
||||
the language of a contract shall be construed against the drafter shall not
|
||||
be used to construe this License against a Contributor.
|
||||
|
||||
|
||||
10. Versions of the License
|
||||
|
||||
10.1. New Versions
|
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section
|
||||
10.3, no one other than the license steward has the right to modify or
|
||||
publish new versions of this License. Each version will be given a
|
||||
distinguishing version number.
|
||||
|
||||
10.2. Effect of New Versions
|
||||
|
||||
You may distribute the Covered Software under the terms of the version
|
||||
of the License under which You originally received the Covered Software,
|
||||
or under the terms of any subsequent version published by the license
|
||||
steward.
|
||||
|
||||
10.3. Modified Versions
|
||||
|
||||
If you create software not governed by this License, and you want to
|
||||
create a new license for such software, you may create and use a
|
||||
modified version of this License if you rename the license and remove
|
||||
any references to the name of the license steward (except to note that
|
||||
such modified license differs from this License).
|
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||
Licenses If You choose to distribute Source Code Form that is
|
||||
Incompatible With Secondary Licenses under the terms of this version of
|
||||
the License, the notice described in Exhibit B of this License must be
|
||||
attached.
|
||||
|
||||
Exhibit A - Source Code Form License Notice
|
||||
|
||||
This Source Code Form is subject to the
|
||||
terms of the Mozilla Public License, v.
|
||||
2.0. If a copy of the MPL was not
|
||||
distributed with this file, You can
|
||||
obtain one at
|
||||
http://mozilla.org/MPL/2.0/.
|
||||
|
||||
If it is not possible or desirable to put the notice in a particular file,
|
||||
then You may include the notice in a location (such as a LICENSE file in a
|
||||
relevant directory) where a recipient would be likely to look for such a
|
||||
notice.
|
||||
|
||||
You may add additional accurate notices of copyright ownership.
|
||||
|
||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||
|
||||
This Source Code Form is "Incompatible
|
||||
With Secondary Licenses", as defined by
|
||||
the Mozilla Public License, v. 2.0.
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
# SCADA Client
|
||||
|
||||
This library provides a Golang client for the [HashiCorp SCADA service](http://scada.hashicorp.com).
|
||||
SCADA stands for Supervisory Control And Data Acquisition, and as the name implies it allows
|
||||
[Atlas](https://atlas.hashicorp.com) to provide control functions and request data from the tools that integrate.
|
||||
|
||||
The technical details about how SCADA works are fairly simple. Clients first open a connection to
|
||||
the SCADA service at scada.hashicorp.com on port 7223. This connection is secured by TLS, allowing
|
||||
clients to verify the identity of the servers and to encrypt all communications. Once connected, a
|
||||
handshake is performed where a client provides it's Atlas API credentials so that Atlas can verify
|
||||
the client identity. Once complete, clients keep the connection open in an idle state waiting for
|
||||
commands to be received. Commands map to APIs exposed by the product, and are subject to any ACLs,
|
||||
authentication or authorization mechanisms of the client.
|
||||
|
||||
This library is used in various HashiCorp products to integrate with the SCADA system.
|
||||
|
||||
## Environmental Variables
|
||||
|
||||
This library respects the following environment variables:
|
||||
|
||||
* ATLAS_TOKEN: The Atlas token to use for authentication
|
||||
* SCADA_ENDPOINT: Overrides the default SCADA endpoint
|
||||
|
|
@ -1,146 +0,0 @@
|
|||
package client
|
||||
|
||||
import (
|
||||
"crypto/tls"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/hashicorp/net-rpc-msgpackrpc"
|
||||
"github.com/hashicorp/yamux"
|
||||
)
|
||||
|
||||
const (
|
||||
// clientPreamble is the preamble to send before upgrading
|
||||
// the connection into a SCADA version 1 connection.
|
||||
clientPreamble = "SCADA 1\n"
|
||||
|
||||
// rpcTimeout is how long of a read deadline we provide
|
||||
rpcTimeout = 10 * time.Second
|
||||
)
|
||||
|
||||
// Opts is used to parameterize a Dial
|
||||
type Opts struct {
|
||||
// Addr is the dial address
|
||||
Addr string
|
||||
|
||||
// TLS controls if TLS is used
|
||||
TLS bool
|
||||
|
||||
// TLSConfig or nil for default
|
||||
TLSConfig *tls.Config
|
||||
|
||||
// Modifies the log output
|
||||
LogOutput io.Writer
|
||||
}
|
||||
|
||||
// Client is a SCADA compatible client. This is a bare bones client that
|
||||
// only handles the framing and RPC protocol. Higher-level clients should
|
||||
// be prefered.
|
||||
type Client struct {
|
||||
conn net.Conn
|
||||
client *yamux.Session
|
||||
|
||||
closed bool
|
||||
closedLock sync.Mutex
|
||||
}
|
||||
|
||||
// Dial is used to establish a new connection over TCP
|
||||
func Dial(addr string) (*Client, error) {
|
||||
opts := Opts{Addr: addr, TLS: false}
|
||||
return DialOpts(&opts)
|
||||
}
|
||||
|
||||
// DialTLS is used to establish a new connection using TLS/TCP
|
||||
func DialTLS(addr string, tlsConf *tls.Config) (*Client, error) {
|
||||
opts := Opts{Addr: addr, TLS: true, TLSConfig: tlsConf}
|
||||
return DialOpts(&opts)
|
||||
}
|
||||
|
||||
// DialOpts is a parameterized Dial
|
||||
func DialOpts(opts *Opts) (*Client, error) {
|
||||
var conn net.Conn
|
||||
var err error
|
||||
if opts.TLS {
|
||||
conn, err = tls.Dial("tcp", opts.Addr, opts.TLSConfig)
|
||||
} else {
|
||||
conn, err = net.DialTimeout("tcp", opts.Addr, 10*time.Second)
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return initClient(conn, opts)
|
||||
}
|
||||
|
||||
// initClient does the common initialization
|
||||
func initClient(conn net.Conn, opts *Opts) (*Client, error) {
|
||||
// Send the preamble
|
||||
_, err := conn.Write([]byte(clientPreamble))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("preamble write failed: %v", err)
|
||||
}
|
||||
|
||||
// Wrap the connection in yamux for multiplexing
|
||||
ymConf := yamux.DefaultConfig()
|
||||
if opts.LogOutput != nil {
|
||||
ymConf.LogOutput = opts.LogOutput
|
||||
}
|
||||
client, _ := yamux.Client(conn, ymConf)
|
||||
|
||||
// Create the client
|
||||
c := &Client{
|
||||
conn: conn,
|
||||
client: client,
|
||||
}
|
||||
return c, nil
|
||||
}
|
||||
|
||||
// Close is used to terminate the client connection
|
||||
func (c *Client) Close() error {
|
||||
c.closedLock.Lock()
|
||||
defer c.closedLock.Unlock()
|
||||
|
||||
if c.closed {
|
||||
return nil
|
||||
}
|
||||
c.closed = true
|
||||
c.client.GoAway() // Notify the other side of the close
|
||||
return c.client.Close()
|
||||
}
|
||||
|
||||
// RPC is used to perform an RPC
|
||||
func (c *Client) RPC(method string, args interface{}, resp interface{}) error {
|
||||
// Get a stream
|
||||
stream, err := c.Open()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to open stream: %v", err)
|
||||
}
|
||||
defer stream.Close()
|
||||
stream.SetDeadline(time.Now().Add(rpcTimeout))
|
||||
|
||||
// Create the RPC client
|
||||
cc := msgpackrpc.NewCodec(true, true, stream)
|
||||
return msgpackrpc.CallWithCodec(cc, method, args, resp)
|
||||
}
|
||||
|
||||
// Accept is used to accept an incoming connection
|
||||
func (c *Client) Accept() (net.Conn, error) {
|
||||
return c.client.Accept()
|
||||
}
|
||||
|
||||
// Open is used to open an outgoing connection
|
||||
func (c *Client) Open() (net.Conn, error) {
|
||||
return c.client.Open()
|
||||
}
|
||||
|
||||
// Addr is so that client can act like a net.Listener
|
||||
func (c *Client) Addr() net.Addr {
|
||||
return c.client.LocalAddr()
|
||||
}
|
||||
|
||||
// NumStreams returns the number of open streams on the client
|
||||
func (c *Client) NumStreams() int {
|
||||
return c.client.NumStreams()
|
||||
}
|
|
@ -1,473 +0,0 @@
|
|||
package client
|
||||
|
||||
import (
|
||||
"crypto/tls"
|
||||
"fmt"
|
||||
"io"
|
||||
"log"
|
||||
"math/rand"
|
||||
"net"
|
||||
"net/rpc"
|
||||
"os"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/armon/go-metrics"
|
||||
"github.com/hashicorp/net-rpc-msgpackrpc"
|
||||
)
|
||||
|
||||
const (
|
||||
// DefaultEndpoint is the endpoint used if none is provided
|
||||
DefaultEndpoint = "scada.hashicorp.com:7223"
|
||||
|
||||
// DefaultBackoff is the amount of time we back off if we encounter
|
||||
// and error, and no specific backoff is available.
|
||||
DefaultBackoff = 120 * time.Second
|
||||
|
||||
// DisconnectDelay is how long we delay the disconnect to allow
|
||||
// the RPC to complete.
|
||||
DisconnectDelay = time.Second
|
||||
)
|
||||
|
||||
// CapabilityProvider is used to provide a given capability
|
||||
// when requested remotely. They must return a connection
|
||||
// that is bridged or an error.
|
||||
type CapabilityProvider func(capability string, meta map[string]string, conn io.ReadWriteCloser) error
|
||||
|
||||
// ProviderService is the service being exposed
|
||||
type ProviderService struct {
|
||||
Service string
|
||||
ServiceVersion string
|
||||
Capabilities map[string]int
|
||||
Meta map[string]string
|
||||
ResourceType string
|
||||
}
|
||||
|
||||
// ProviderConfig is used to parameterize a provider
|
||||
type ProviderConfig struct {
|
||||
// Endpoint is the SCADA endpoint, defaults to DefaultEndpoint
|
||||
Endpoint string
|
||||
|
||||
// Service is the service to expose
|
||||
Service *ProviderService
|
||||
|
||||
// Handlers are invoked to provide the named capability
|
||||
Handlers map[string]CapabilityProvider
|
||||
|
||||
// ResourceGroup is the named group e.g. "hashicorp/prod"
|
||||
ResourceGroup string
|
||||
|
||||
// Token is the Atlas authentication token
|
||||
Token string
|
||||
|
||||
// Optional TLS configuration, defaults used otherwise
|
||||
TLSConfig *tls.Config
|
||||
|
||||
// LogOutput is to control the log output
|
||||
LogOutput io.Writer
|
||||
}
|
||||
|
||||
// Provider is a high-level interface to SCADA by which
|
||||
// clients declare themselves as a service providing capabilities.
|
||||
// Provider manages the client/server interactions required,
|
||||
// making it simpler to integrate.
|
||||
type Provider struct {
|
||||
config *ProviderConfig
|
||||
logger *log.Logger
|
||||
|
||||
client *Client
|
||||
clientLock sync.Mutex
|
||||
|
||||
noRetry bool // set when the server instructs us to not retry
|
||||
backoff time.Duration // set when the server provides a longer backoff
|
||||
backoffLock sync.Mutex
|
||||
|
||||
sessionID string
|
||||
sessionAuth bool
|
||||
sessionLock sync.RWMutex
|
||||
|
||||
shutdown bool
|
||||
shutdownCh chan struct{}
|
||||
shutdownLock sync.Mutex
|
||||
}
|
||||
|
||||
// validateConfig is used to sanity check the configuration
|
||||
func validateConfig(config *ProviderConfig) error {
|
||||
// Validate the inputs
|
||||
if config == nil {
|
||||
return fmt.Errorf("missing config")
|
||||
}
|
||||
if config.Service == nil {
|
||||
return fmt.Errorf("missing service")
|
||||
}
|
||||
if config.Service.Service == "" {
|
||||
return fmt.Errorf("missing service name")
|
||||
}
|
||||
if config.Service.ServiceVersion == "" {
|
||||
return fmt.Errorf("missing service version")
|
||||
}
|
||||
if config.Service.ResourceType == "" {
|
||||
return fmt.Errorf("missing service resource type")
|
||||
}
|
||||
if config.Handlers == nil && len(config.Service.Capabilities) != 0 {
|
||||
return fmt.Errorf("missing handlers")
|
||||
}
|
||||
for c := range config.Service.Capabilities {
|
||||
if _, ok := config.Handlers[c]; !ok {
|
||||
return fmt.Errorf("missing handler for '%s' capability", c)
|
||||
}
|
||||
}
|
||||
if config.ResourceGroup == "" {
|
||||
return fmt.Errorf("missing resource group")
|
||||
}
|
||||
if config.Token == "" {
|
||||
config.Token = os.Getenv("ATLAS_TOKEN")
|
||||
}
|
||||
if config.Token == "" {
|
||||
return fmt.Errorf("missing token")
|
||||
}
|
||||
|
||||
// Default the endpoint
|
||||
if config.Endpoint == "" {
|
||||
config.Endpoint = DefaultEndpoint
|
||||
if end := os.Getenv("SCADA_ENDPOINT"); end != "" {
|
||||
config.Endpoint = end
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// NewProvider is used to create a new provider
|
||||
func NewProvider(config *ProviderConfig) (*Provider, error) {
|
||||
if err := validateConfig(config); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Create logger
|
||||
if config.LogOutput == nil {
|
||||
config.LogOutput = os.Stderr
|
||||
}
|
||||
logger := log.New(config.LogOutput, "", log.LstdFlags)
|
||||
|
||||
p := &Provider{
|
||||
config: config,
|
||||
logger: logger,
|
||||
shutdownCh: make(chan struct{}),
|
||||
}
|
||||
go p.run()
|
||||
return p, nil
|
||||
}
|
||||
|
||||
// Shutdown is used to close the provider
|
||||
func (p *Provider) Shutdown() {
|
||||
p.shutdownLock.Lock()
|
||||
p.shutdownLock.Unlock()
|
||||
if p.shutdown {
|
||||
return
|
||||
}
|
||||
p.shutdown = true
|
||||
close(p.shutdownCh)
|
||||
}
|
||||
|
||||
// IsShutdown checks if we have been shutdown
|
||||
func (p *Provider) IsShutdown() bool {
|
||||
select {
|
||||
case <-p.shutdownCh:
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// backoffDuration is used to compute the next backoff duration
|
||||
func (p *Provider) backoffDuration() time.Duration {
|
||||
// Use the default backoff
|
||||
backoff := DefaultBackoff
|
||||
|
||||
// Check for a server specified backoff
|
||||
p.backoffLock.Lock()
|
||||
if p.backoff != 0 {
|
||||
backoff = p.backoff
|
||||
}
|
||||
if p.noRetry {
|
||||
backoff = 0
|
||||
}
|
||||
p.backoffLock.Unlock()
|
||||
|
||||
return backoff
|
||||
}
|
||||
|
||||
// wait is used to delay dialing on an error
|
||||
func (p *Provider) wait() {
|
||||
// Compute the backoff time
|
||||
backoff := p.backoffDuration()
|
||||
|
||||
// Setup a wait timer
|
||||
var wait <-chan time.Time
|
||||
if backoff > 0 {
|
||||
jitter := time.Duration(rand.Uint32()) % backoff
|
||||
wait = time.After(backoff + jitter)
|
||||
}
|
||||
|
||||
// Wait until timer or shutdown
|
||||
select {
|
||||
case <-wait:
|
||||
case <-p.shutdownCh:
|
||||
}
|
||||
}
|
||||
|
||||
// run is a long running routine to manage the provider
|
||||
func (p *Provider) run() {
|
||||
for !p.IsShutdown() {
|
||||
// Setup a new connection
|
||||
client, err := p.clientSetup()
|
||||
if err != nil {
|
||||
p.wait()
|
||||
continue
|
||||
}
|
||||
|
||||
// Handle the session
|
||||
doneCh := make(chan struct{})
|
||||
go p.handleSession(client, doneCh)
|
||||
|
||||
// Wait for session termination or shutdown
|
||||
select {
|
||||
case <-doneCh:
|
||||
p.wait()
|
||||
case <-p.shutdownCh:
|
||||
p.clientLock.Lock()
|
||||
client.Close()
|
||||
p.clientLock.Unlock()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// handleSession is used to handle an established session
|
||||
func (p *Provider) handleSession(list net.Listener, doneCh chan struct{}) {
|
||||
defer close(doneCh)
|
||||
defer list.Close()
|
||||
// Accept new connections
|
||||
for !p.IsShutdown() {
|
||||
conn, err := list.Accept()
|
||||
if err != nil {
|
||||
p.logger.Printf("[ERR] scada-client: failed to accept connection: %v", err)
|
||||
return
|
||||
}
|
||||
p.logger.Printf("[DEBUG] scada-client: accepted connection")
|
||||
go p.handleConnection(conn)
|
||||
}
|
||||
}
|
||||
|
||||
// handleConnection handles an incoming connection
|
||||
func (p *Provider) handleConnection(conn net.Conn) {
|
||||
// Create an RPC server to handle inbound
|
||||
pe := &providerEndpoint{p: p}
|
||||
rpcServer := rpc.NewServer()
|
||||
rpcServer.RegisterName("Client", pe)
|
||||
rpcCodec := msgpackrpc.NewCodec(false, false, conn)
|
||||
|
||||
defer func() {
|
||||
if !pe.hijacked() {
|
||||
conn.Close()
|
||||
}
|
||||
}()
|
||||
|
||||
for !p.IsShutdown() {
|
||||
if err := rpcServer.ServeRequest(rpcCodec); err != nil {
|
||||
if err != io.EOF && !strings.Contains(err.Error(), "closed") {
|
||||
p.logger.Printf("[ERR] scada-client: RPC error: %v", err)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// Handle potential hijack in Client.Connect
|
||||
if pe.hijacked() {
|
||||
cb := pe.getHijack()
|
||||
cb(conn)
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// clientSetup is used to setup a new connection
|
||||
func (p *Provider) clientSetup() (*Client, error) {
|
||||
defer metrics.MeasureSince([]string{"scada", "setup"}, time.Now())
|
||||
|
||||
// Reset the previous backoff
|
||||
p.backoffLock.Lock()
|
||||
p.noRetry = false
|
||||
p.backoff = 0
|
||||
p.backoffLock.Unlock()
|
||||
|
||||
// Dial a new connection
|
||||
opts := Opts{
|
||||
Addr: p.config.Endpoint,
|
||||
TLS: true,
|
||||
TLSConfig: p.config.TLSConfig,
|
||||
LogOutput: p.config.LogOutput,
|
||||
}
|
||||
client, err := DialOpts(&opts)
|
||||
if err != nil {
|
||||
p.logger.Printf("[ERR] scada-client: failed to dial: %v", err)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Perform a handshake
|
||||
resp, err := p.handshake(client)
|
||||
if err != nil {
|
||||
p.logger.Printf("[ERR] scada-client: failed to handshake: %v", err)
|
||||
client.Close()
|
||||
return nil, err
|
||||
}
|
||||
if resp != nil && resp.SessionID != "" {
|
||||
p.logger.Printf("[DEBUG] scada-client: assigned session '%s'", resp.SessionID)
|
||||
}
|
||||
if resp != nil && !resp.Authenticated {
|
||||
p.logger.Printf("[WARN] scada-client: authentication failed: %v", resp.Reason)
|
||||
}
|
||||
|
||||
// Set the new client
|
||||
p.clientLock.Lock()
|
||||
if p.client != nil {
|
||||
p.client.Close()
|
||||
}
|
||||
p.client = client
|
||||
p.clientLock.Unlock()
|
||||
|
||||
p.sessionLock.Lock()
|
||||
p.sessionID = resp.SessionID
|
||||
p.sessionAuth = resp.Authenticated
|
||||
p.sessionLock.Unlock()
|
||||
|
||||
return client, nil
|
||||
}
|
||||
|
||||
// SessionID provides the current session ID
|
||||
func (p *Provider) SessionID() string {
|
||||
p.sessionLock.RLock()
|
||||
defer p.sessionLock.RUnlock()
|
||||
return p.sessionID
|
||||
}
|
||||
|
||||
// SessionAuth checks if the current session is authenticated
|
||||
func (p *Provider) SessionAuthenticated() bool {
|
||||
p.sessionLock.RLock()
|
||||
defer p.sessionLock.RUnlock()
|
||||
return p.sessionAuth
|
||||
}
|
||||
|
||||
// handshake does the initial handshake
|
||||
func (p *Provider) handshake(client *Client) (*HandshakeResponse, error) {
|
||||
defer metrics.MeasureSince([]string{"scada", "handshake"}, time.Now())
|
||||
req := HandshakeRequest{
|
||||
Service: p.config.Service.Service,
|
||||
ServiceVersion: p.config.Service.ServiceVersion,
|
||||
Capabilities: p.config.Service.Capabilities,
|
||||
Meta: p.config.Service.Meta,
|
||||
ResourceType: p.config.Service.ResourceType,
|
||||
ResourceGroup: p.config.ResourceGroup,
|
||||
Token: p.config.Token,
|
||||
}
|
||||
resp := new(HandshakeResponse)
|
||||
if err := client.RPC("Session.Handshake", &req, resp); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
type HijackFunc func(io.ReadWriteCloser)
|
||||
|
||||
// providerEndpoint is used to implement the Client.* RPC endpoints
|
||||
// as part of the provider.
|
||||
type providerEndpoint struct {
|
||||
p *Provider
|
||||
hijack HijackFunc
|
||||
}
|
||||
|
||||
// Hijacked is used to check if the connection has been hijacked
|
||||
func (pe *providerEndpoint) hijacked() bool {
|
||||
return pe.hijack != nil
|
||||
}
|
||||
|
||||
// GetHijack returns the hijack function
|
||||
func (pe *providerEndpoint) getHijack() HijackFunc {
|
||||
return pe.hijack
|
||||
}
|
||||
|
||||
// Hijack is used to take over the yamux stream for Client.Connect
|
||||
func (pe *providerEndpoint) setHijack(cb HijackFunc) {
|
||||
pe.hijack = cb
|
||||
}
|
||||
|
||||
// Connect is invoked by the broker to connect to a capability
|
||||
func (pe *providerEndpoint) Connect(args *ConnectRequest, resp *ConnectResponse) error {
|
||||
defer metrics.IncrCounter([]string{"scada", "connect", args.Capability}, 1)
|
||||
pe.p.logger.Printf("[INFO] scada-client: connect requested (capability: %s)",
|
||||
args.Capability)
|
||||
|
||||
// Handle potential flash
|
||||
if args.Severity != "" && args.Message != "" {
|
||||
pe.p.logger.Printf("[%s] scada-client: %s", args.Severity, args.Message)
|
||||
}
|
||||
|
||||
// Look for the handler
|
||||
handler := pe.p.config.Handlers[args.Capability]
|
||||
if handler == nil {
|
||||
pe.p.logger.Printf("[WARN] scada-client: requested capability '%s' not available",
|
||||
args.Capability)
|
||||
return fmt.Errorf("invalid capability")
|
||||
}
|
||||
|
||||
// Hijack the connection
|
||||
pe.setHijack(func(a io.ReadWriteCloser) {
|
||||
if err := handler(args.Capability, args.Meta, a); err != nil {
|
||||
pe.p.logger.Printf("[ERR] scada-client: '%s' handler error: %v",
|
||||
args.Capability, err)
|
||||
}
|
||||
})
|
||||
resp.Success = true
|
||||
return nil
|
||||
}
|
||||
|
||||
// Disconnect is invoked by the broker to ask us to backoff
|
||||
func (pe *providerEndpoint) Disconnect(args *DisconnectRequest, resp *DisconnectResponse) error {
|
||||
defer metrics.IncrCounter([]string{"scada", "disconnect"}, 1)
|
||||
if args.Reason == "" {
|
||||
args.Reason = "<no reason provided>"
|
||||
}
|
||||
pe.p.logger.Printf("[INFO] scada-client: disconnect requested (retry: %v, backoff: %v): %v",
|
||||
!args.NoRetry, args.Backoff, args.Reason)
|
||||
|
||||
// Use the backoff information
|
||||
pe.p.backoffLock.Lock()
|
||||
pe.p.noRetry = args.NoRetry
|
||||
pe.p.backoff = args.Backoff
|
||||
pe.p.backoffLock.Unlock()
|
||||
|
||||
// Clear the session information
|
||||
pe.p.sessionLock.Lock()
|
||||
pe.p.sessionID = ""
|
||||
pe.p.sessionAuth = false
|
||||
pe.p.sessionLock.Unlock()
|
||||
|
||||
// Force the disconnect
|
||||
time.AfterFunc(DisconnectDelay, func() {
|
||||
pe.p.clientLock.Lock()
|
||||
if pe.p.client != nil {
|
||||
pe.p.client.Close()
|
||||
}
|
||||
pe.p.clientLock.Unlock()
|
||||
})
|
||||
return nil
|
||||
}
|
||||
|
||||
// Flash is invoked by the broker log a message
|
||||
func (pe *providerEndpoint) Flash(args *FlashRequest, resp *FlashResponse) error {
|
||||
defer metrics.IncrCounter([]string{"scada", "flash"}, 1)
|
||||
if args.Severity != "" && args.Message != "" {
|
||||
pe.p.logger.Printf("[%s] scada-client: %s", args.Severity, args.Message)
|
||||
}
|
||||
return nil
|
||||
}
|
|
@ -1,49 +0,0 @@
|
|||
package client
|
||||
|
||||
import "time"
|
||||
|
||||
// HandshakeRequest is used to authenticate the session
|
||||
type HandshakeRequest struct {
|
||||
Service string
|
||||
ServiceVersion string
|
||||
Capabilities map[string]int
|
||||
Meta map[string]string
|
||||
ResourceType string
|
||||
ResourceGroup string
|
||||
Token string
|
||||
}
|
||||
|
||||
type HandshakeResponse struct {
|
||||
Authenticated bool
|
||||
SessionID string
|
||||
Reason string
|
||||
}
|
||||
|
||||
type ConnectRequest struct {
|
||||
Capability string
|
||||
Meta map[string]string
|
||||
|
||||
Severity string
|
||||
Message string
|
||||
}
|
||||
|
||||
type ConnectResponse struct {
|
||||
Success bool
|
||||
}
|
||||
|
||||
type DisconnectRequest struct {
|
||||
NoRetry bool // Should the client retry
|
||||
Backoff time.Duration // Minimum backoff
|
||||
Reason string
|
||||
}
|
||||
|
||||
type DisconnectResponse struct {
|
||||
}
|
||||
|
||||
type FlashRequest struct {
|
||||
Severity string
|
||||
Message string
|
||||
}
|
||||
|
||||
type FlashResponse struct {
|
||||
}
|
|
@ -625,12 +625,6 @@
|
|||
"revision": "d1e82c1ec3f15ee991f7cc7ffd5b67ff6f5bbaee",
|
||||
"revisionTime": "2015-02-01T20:08:39Z"
|
||||
},
|
||||
{
|
||||
"checksumSHA1": "u9qHbpIgMZ7/fjO0gFfds2m/1ck=",
|
||||
"path": "github.com/hashicorp/scada-client",
|
||||
"revision": "6e896784f66f82cdc6f17e00052db91699dc277d",
|
||||
"revisionTime": "2016-06-01T22:40:23Z"
|
||||
},
|
||||
{
|
||||
"checksumSHA1": "E3Xcanc9ouQwL+CZGOUyA/+giLg=",
|
||||
"comment": "v0.7.0-66-g6c4672d",
|
||||
|
|
Loading…
Reference in New Issue