1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
//
// Copyright (c) SAS Institute Inc.
//
// 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.
//
package workercmd
import (
"context"
"crypto"
"crypto/hmac"
"crypto/rsa"
"crypto/x509"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"os"
"time"
"github.com/miekg/pkcs11"
"github.com/rs/zerolog/log"
"github.com/sassoftware/relic/v7/cmdline/shared"
"github.com/sassoftware/relic/v7/internal/workerrpc"
"github.com/sassoftware/relic/v7/token"
"github.com/sassoftware/relic/v7/token/tokencache"
)
// an arbitarily-chosen set of error codes that indicate that the token session
// is busted and that the worker should exit and start over
var fatalErrors = map[pkcs11Error]bool{
pkcs11.CKR_CRYPTOKI_NOT_INITIALIZED: true,
pkcs11.CKR_DEVICE_REMOVED: true,
pkcs11.CKR_GENERAL_ERROR: true,
pkcs11.CKR_HOST_MEMORY: true,
pkcs11.CKR_LIBRARY_LOAD_FAILED: true,
pkcs11.CKR_SESSION_CLOSED: true,
pkcs11.CKR_SESSION_HANDLE_INVALID: true,
pkcs11.CKR_TOKEN_NOT_PRESENT: true,
pkcs11.CKR_TOKEN_NOT_RECOGNIZED: true,
pkcs11.CKR_USER_NOT_LOGGED_IN: true,
}
func (h *handler) healthCheck() {
interval := time.Duration(shared.CurrentConfig.Server.TokenCheckInterval) * time.Second
timeout := time.Duration(shared.CurrentConfig.Server.TokenCheckTimeout) * time.Second
ppid := os.Getppid()
tick := time.NewTicker(interval)
errch := make(chan error)
for {
// check if parent process went away
if os.Getppid() != ppid {
log.Error().
Int("old_ppid", ppid).Int("new_ppid", os.Getppid()).
Msg("parent process disappeared, worker stopping")
h.shutdown()
return
}
// check if token is alive
ctx, cancel := context.WithTimeout(context.Background(), timeout)
go func() {
errch <- h.token.Ping(ctx)
}()
var err error
select {
case err = <-errch:
// ping completed
case <-ctx.Done():
// timed out
err = fmt.Errorf("timed out after %s", timeout)
}
cancel()
if err != nil {
// stop the worker on error
log.Err(err).Msg("token health check failed")
h.shutdown()
return
}
// wait for next tick
<-tick.C
}
}
type handler struct {
token *tokencache.Cache
cookie []byte
shutdown func()
}
func (h *handler) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
// validate auth cookie
cookie := req.Header.Get("Auth-Cookie")
if !hmac.Equal([]byte(cookie), []byte(h.cookie)) {
rw.WriteHeader(http.StatusForbidden)
return
}
// dispatch
resp, err := h.handle(rw, req)
if err != nil {
resp.Retryable = true
resp.Err = err.Error()
switch e := err.(type) {
case pkcs11Error:
if fatalErrors[e] {
log.Err(err).Msg("terminating worker due to token error")
go h.shutdown()
// errors that cause the worker to restart are also retryable
resp.Retryable = true
} else {
// pkcs11 errors not in fatalErrors are probably user error, so don't retry
resp.Retryable = false
}
case token.NotImplementedError:
resp.Retryable = false
case token.KeyUsageError:
resp.Retryable = false
resp.Usage = true
resp.Key = e.Key
resp.Err = e.Err.Error()
}
}
// marshal response
blob, err := json.Marshal(resp)
if err == nil {
_, err = rw.Write(blob)
}
if err != nil {
log.Err(err).Msg("error handling worker request")
}
}
func (h *handler) handle(rw http.ResponseWriter, req *http.Request) (resp workerrpc.Response, err error) {
blob, err := io.ReadAll(req.Body)
if err != nil {
return resp, err
}
var rr workerrpc.Request
if err := json.Unmarshal(blob, &rr); err != nil {
return resp, err
}
ctx := req.Context()
if rr.KeyID != nil {
// if the caller knows the key ID already, pass that along to ensure the
// same key is used in case it got rotated
ctx = token.WithKeyID(ctx, rr.KeyID)
}
switch req.URL.Path {
case workerrpc.Ping:
return resp, h.token.Ping(ctx)
case workerrpc.GetKey:
key, err := h.token.GetKey(ctx, rr.KeyName)
if err != nil {
return resp, err
}
resp.ID = key.GetID()
resp.Cert = key.Certificate()
resp.Value, err = x509.MarshalPKIXPublicKey(key.Public())
return resp, err
case workerrpc.Sign:
hash := crypto.Hash(rr.Hash)
opts := crypto.SignerOpts(hash)
if rr.SaltLength != nil {
opts = &rsa.PSSOptions{SaltLength: *rr.SaltLength, Hash: hash}
}
key, err := h.token.GetKey(ctx, rr.KeyName)
if err != nil {
return resp, err
}
resp.Value, err = key.SignContext(ctx, rr.Digest, opts)
return resp, err
default:
return resp, errors.New("invalid method: " + req.URL.Path)
}
}
|