Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

S3_Upload: Adding KMS and Prefix arguments #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions artifacts/definitions/Server/Utils/CreateCollector.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ parameters:
region=TargetArgs.region,
endpoint=TargetArgs.endpoint,
serversideencryption=TargetArgs.serverSideEncryption,
kmsencryptionkey=TargetArgs.kmsEncryptionKey,
s3uploadroot=TargetArgs.s3UploadRoot,
noverifycert=TargetArgs.noverifycert)

- name: GCSCollection
Expand Down
61 changes: 46 additions & 15 deletions gui/velociraptor/src/components/flows/offline-collector.jsx
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
import React from 'react';
import PropTypes from 'prop-types';
import _ from 'lodash';
import Modal from 'react-bootstrap/Modal';
import StepWizard from 'react-step-wizard';
import Form from 'react-bootstrap/Form';
import Row from 'react-bootstrap/Row';
import Col from 'react-bootstrap/Col';
import ToolViewer from "../tools/tool-viewer.jsx";
import { HotKeys, ObserveKeys } from "react-hotkeys";
import ValidatedInteger from '../forms/validated_int.jsx';
import T from '../i8n/i8n.jsx';
import NewCollectionConfigParameters from './new-collections-parameters.jsx';

import {
NewCollectionSelectArtifacts,
NewCollectionRequest,
NewCollectionLaunch,
NewCollectionRequest,
NewCollectionSelectArtifacts,
PaginationBuilder
} from './new-collection.jsx';

import Col from 'react-bootstrap/Col';
import Form from 'react-bootstrap/Form';
import Modal from 'react-bootstrap/Modal';
import NewCollectionConfigParameters from './new-collections-parameters.jsx';
import PropTypes from 'prop-types';
import React from 'react';
import Row from 'react-bootstrap/Row';
import StepWizard from 'react-step-wizard';
import T from '../i8n/i8n.jsx';
import ToolViewer from "../tools/tool-viewer.jsx";
import ValidatedInteger from '../forms/validated_int.jsx';
import _ from 'lodash';

// The offline collection wizard is built upon the new collection
// wizard with some extra steps.
Expand Down Expand Up @@ -325,6 +324,21 @@ class OfflineCollectorParameters extends React.Component {
</Col>
</Form.Group>
<Form.Group as={Row}>
<Form.Label column sm="3">File Name Prefix</Form.Label>
<Col sm="8">
<Form.Control as="textarea" rows={3}
placeholder={T("Prefix for files being uploaded. end in / for folders (blank if not used)")}
spellCheck="false"
value={this.props.parameters.target_args.s3UploadRoot}
onChange={(e) => {
this.props.parameters.target_args.s3UploadRoot = e.target.value;
this.props.setParameters(this.props.parameters);
}}
>
</Form.Control>
</Col>
</Form.Group>
<Form.Group as={Row}>
<Form.Label column sm="3">{T("Server Side Encryption")}</Form.Label>
<Col sm="8">
<Form.Control
Expand All @@ -342,6 +356,21 @@ class OfflineCollectorParameters extends React.Component {
</Col>
</Form.Group>
<Form.Group as={Row}>
<Form.Label column sm="3">KMS Encryption Key</Form.Label>
<Col sm="8">
<Form.Control as="textarea" rows={3}
placeholder={T("KMS Encryption Key ARN (blank if KMS not used)")}
spellCheck="false"
value={this.props.parameters.target_args.kmsEncryptionKey}
onChange={(e) => {
this.props.parameters.target_args.kmsEncryptionKey = e.target.value;
this.props.setParameters(this.props.parameters);
}}
>
</Form.Control>
</Col>
</Form.Group>
<Form.Group as={Row}>
<Form.Label column sm="3">{T("Skip Cert Verification")}</Form.Label>
<Col sm="8">
<Form.Control
Expand Down Expand Up @@ -683,6 +712,8 @@ export default class OfflineCollectorWizard extends React.Component {
region: "",
endpoint: "",
serverSideEncryption: "",
kmsEncryptionKey: "",
s3UploadRoot: "",

// For Azure
sas_url: "",
Expand Down
38 changes: 24 additions & 14 deletions vql/tools/s3_upload.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ type S3UploadArgs struct {
CredentialsSecret string `vfilter:"optional,field=credentialssecret,doc=The AWS secret credentials to use"`
Endpoint string `vfilter:"optional,field=endpoint,doc=The Endpoint to use"`
ServerSideEncryption string `vfilter:"optional,field=serversideencryption,doc=The server side encryption method to use"`
KmsEncryptionKey string `vfilter:"optional,field=kmsencryptionkey,doc=The server side KMS key to use"`
S3UploadRoot string `vfilter:"optional,field=s3uploadroot,doc=Prefix for the S3 object"`
NoVerifyCert bool `vfilter:"optional,field=noverifycert,doc=Skip TLS Verification (deprecated in favor of SkipVerify)"`
SkipVerify bool `vfilter:"optional,field=skip_verify,doc=Skip TLS Verification"`
}
Expand Down Expand Up @@ -96,6 +98,8 @@ func (self *S3UploadFunction) Call(ctx context.Context,
arg.Region,
arg.Endpoint,
arg.ServerSideEncryption,
arg.KmsEncryptionKey,
arg.S3UploadRoot,
arg.NoVerifyCert || arg.SkipVerify,
uint64(stat.Size()))
if err != nil {
Expand All @@ -117,10 +121,15 @@ func upload_S3(ctx context.Context, scope vfilter.Scope,
region string,
endpoint string,
serverSideEncryption string,
kmsEncryptionKey string,
s3UploadRoot string,
NoVerifyCert bool,
size uint64) (
*uploads.UploadResponse, error) {

if s3UploadRoot != "" {
name = s3UploadRoot + name
}
scope.Log("upload_S3: Uploading %v to %v", name, bucket)

conf := aws.NewConfig().WithRegion(region)
Expand Down Expand Up @@ -172,22 +181,23 @@ func upload_S3(ctx context.Context, scope vfilter.Scope,

uploader := s3manager.NewUploader(sess)
var result *s3manager.UploadOutput

s3_params := &s3manager.UploadInput{
Bucket: aws.String(bucket),
Key: aws.String(name),
Body: reader,
}
if serverSideEncryption != "" {
result, err = uploader.UploadWithContext(
ctx, &s3manager.UploadInput{
Bucket: aws.String(bucket),
Key: aws.String(name),
ServerSideEncryption: aws.String(serverSideEncryption),
Body: reader,
})
} else {
result, err = uploader.UploadWithContext(
ctx, &s3manager.UploadInput{
Bucket: aws.String(bucket),
Key: aws.String(name),
Body: reader,
})
s3_params.ServerSideEncryption = aws.String(serverSideEncryption)
}

if kmsEncryptionKey != "" {
s3_params.SSEKMSKeyId = aws.String(kmsEncryptionKey)
}

result, err = uploader.UploadWithContext(
ctx, s3_params)

if err != nil {
return &uploads.UploadResponse{
Error: err.Error(),
Expand Down