Commit graph

64 commits

Author SHA1 Message Date
noahtalerman
718c644471
Documentation for RBAC and teams (#472)
- Add permissions.md and teams.md
2021-06-09 19:12:45 -04:00
noahtalerman
9b6c8d36e4
Additions and changes to Fleet REST API for multiple teams (#383)
- Add API documentation for Teams and RBAC features support
2021-06-09 19:11:48 -04:00
Zach Wasserman
6013194c1d
Reduce default session duration to 4 hours (#981) 2021-06-06 18:28:47 -07:00
Zach Wasserman
0356115b03
Remove JWT in Fleet session management (#979)
See #978 for motivations for this change.

Closes #978.
2021-06-06 18:10:58 -07:00
Zach Wasserman
db459d3363
Continue to update names in backend code and docs (#976) 2021-06-06 16:58:23 -07:00
Zach Wasserman
fa01df79d5 Merge branch 'master' into teams 2021-06-05 06:27:38 -07:00
Zach Wasserman
08d57b40d1
Remove deprecated kolide names from API routes and configuration (#957)
Closes #260
2021-06-04 16:51:18 -07:00
Mike McNeil
8b04c0c634
make example work from root dir of repo 2021-06-04 01:35:59 -05:00
Zach Wasserman
a5bd03e5d7 Merge branch 'master' into teams 2021-05-31 10:56:50 -07:00
Zach Wasserman
64f2cfc9cd
Refactor enroll secrets to support Teams (#903)
- Add `team_id` field to secrets.
- Remove secret `name` and `active` fields (migration deletes inactive secrets).
- Assign hosts to Team based on secret provided.
- Add API for retrieving secrets by Team.
2021-05-31 09:02:05 -07:00
Mike McNeil
7bb202f961
Publish fleetdm.com/queries (#899)
* /sandbox/queries becomes /queries, etc

* Publish fleetdm.com/queries

Expose query library routes the rest of the way, move remediation data sanitization to the point of entry, and update query library to match (pairing w/ @gillespi314)

* Fix accidental commit of sailsrc (again)
2021-05-28 17:51:47 -05:00
Mike McNeil
1512089384
add contributors to a query 2021-05-28 16:46:33 -05:00
Zach Wasserman
8ee47f8b23
Add support for Teams in targets and live queries (#880)
- Accept Teams as a searchable target type for the target selection API.
- Accept Teams for targets in running live queries.
- Refactoring to support these changes.
- Update API documentation.
2021-05-27 13:18:00 -07:00
Zach Wasserman
cebd4df0f5
Update live query and targets APIs for Teams (#876)
- Take query_id in live query and target APIs.
- Use query_id to determine observer targets.
- Update documentation.
2021-05-26 20:45:06 -07:00
Zach Wasserman
48c413a254
Split host additional into separate table (#875)
- Move host `additional` into a separate table.
- Join when that data is needed.
- API change: `/api/v1/fleet/hosts` now returns only the requested
  `additional` columns, unless `*` is provided as the sole argument.

Background:

A customer reported that MySQL binlogs grew huge and replication lag
went way up when data was stored in the `additional` column. In this
deployment MySQL was running with ROW replication. This would cause the
entire `additional` data to be copied on each update of the host checkin
time. While switching to STATEMENT or MIXED replication would likely
mitigate the issue, this was not an option in their environment.
2021-05-26 16:24:12 -07:00
Zach Wasserman
a2a7082bd3
Implement add hosts to team by filters API (#866)
- Add hosts to team using label, status, and query filters.
- Documentation (+ docs for regular add hosts to team).
2021-05-25 21:29:52 -07:00
Zach Wasserman
15b81824f5
Filter query page API responses based on team membership (#850)
- Include only hosts that the user has access to in search targets API.
- Add parameter to specify whether `observer` hosts should be included.
- Generate counts based on which hosts user can access.
- Update API doc.
2021-05-24 21:34:08 -07:00
Mike McNeil
6fa518a300
Update 3-REST-API.md (#825) 2021-05-21 05:31:21 -05:00
Mike McNeil
6330b1ddc3
remove duplicate from standard query library
This will be prevented in the future by https://github.com/fleetdm/fleet/pull/827/files#diff-f6ef0e28b3715762f83a980eaadda37aec5c7ffe9ef9b19d303f53def956b98bR36
(which is how this got noticed )
2021-05-21 04:18:22 -05:00
noahtalerman
0c51f9de56
Add question about upgrading to FAQ (#821)
- Add question that addresses upgrading from Kolide Fleet to FleetDM Fleet
- Edit "Automatically add hosts to packs" question and move portion about `targets` field to `fleetctl` docs
2021-05-20 13:00:46 -04:00
Ahmed Elshaer
e18f154710
Add queries to Standard Query Library (#771)
Adds the following queries to the Standard query library:
- Get authorized keys for Local Accounts
- Get authorized keys for Domain Joined Accounts
- Get current users with active shell/console on the system
- Get Disk encryption status
- Detect Unencrypted SSH Keys for Local Accounts
- Detect Unencrypted SSH Keys for Domain Joined Accounts
- Line parsed values from system and user cron/tab
- Detect Dynamic Linker Hijacking (MITRE. T1574.006)
- Get etc hosts entries
- Get Network Interfaces
- Get Local User Accounts
- Detect active user accounts on servers
- Detect Nmap Scanner
- Get docker images on a system
- Get docker running containers on a system
- Get docker running process on a system
2021-05-19 11:21:45 -07:00
Noah Talerman
72882e8f9f Merge branch 'master' into teams 2021-05-19 13:16:54 -04:00
Mike McNeil
cc018bcfa6
Add "contributors" to YAML format to enable attribution (#780) 2021-05-18 10:33:40 -05:00
noahtalerman
7d9ca2cee7
Convert standard query library to YAML format (#749)
- Create `/configuration-files/` directory inside of `/1-Using-Fleet` directory. This directory contains example Fleet configuration files in yaml format. Replaces the `/examples` directory.
- Create `/standard-query-library/` directory inside of `/1-Using-Fleet` directory. This directory contains the new `standard-query-library.yml`. This file will act as the source of community contributions to the standard query library.
- Edit references to `/examples` directory
2021-05-14 13:38:33 -04:00
Zach Wasserman
daa8eeb9d0
Add refetch host API (#767)
This allows the host details to be refetched on the next check in,
rather than waiting for the normal interval to go by. Associated UI
changes are in-progress.

- Migration and service methods for requesting refetch.
- Expose refetch over API.
- Change detail query logic to respect this flag.
2021-05-13 13:09:22 -07:00
noahtalerman
834ff4371c
Add "how to automatically target hosts" to 1-Using Fleet/FAQ docs (#751)
- Add question and answer to the following question: How do I automatically add hosts to packs when the hosts enroll to Fleet?
2021-05-10 18:54:27 -04:00
noahtalerman
40f2452e46
Change markdown links to relative links (#731)
My changes to the documentation file structure made in #717 resolved all broken documentation links on the `master` branch but not on the `teams` branch. As a result, those developing on the `teams` branch always get a   for the "Markdown link check" test.

- Add relative markdown links in the `teams` branch to resolve failed link test
2021-05-06 10:59:18 -04:00
noahtalerman
ea05195200
Add questions to FAQ and add documentation section to CONTRIBUTING.md (#726)
- Add section on contributing to Fleet documentation. This section covers the use of relative links and best practices for anchor links
- Add 3 questions and their respective answers to the FAQ section in the `1-Using-Fleet` docs
2021-05-05 18:00:05 -04:00
noahtalerman
9fb9da31f5
Bring Orbit docs into Fleet docs and add FAQ section (#717)
- Add new `2-Orbit-osquery/` directory to the top-level `docs/` directory.
- Rename `2-Deployment/` -> `3-Deployment/` to accommodate new Orbit directory.
- Rename `3-Contribution/` ->  `4-Contribution/` to accommodate new Orbit directory.
- Add FAQ section to Orbit documentation.
2021-05-04 15:50:18 -04:00
Zach Wasserman
3b81cb88e9
Update documentation on size of Fleet deployments (#718)
Better represents the growth of Fleet deployment size.
2021-05-04 11:09:23 -07:00
Zach Wasserman
a17556b2db Merge branch 'master' into teams 2021-04-30 09:40:10 -07:00
noahtalerman
b4e5097356
Draft API changes to api/v1/fleet/hosts/{id} endpoint for software inventory (#669)
Update documentation for the `api/v1/fleet/hosts/{id}` endpoint to align with the first iteration of Software inventory #399 in Fleet.
2021-04-29 11:25:54 -04:00
noahtalerman
dbfbde37b1
Add api/v1/status/ endpoints and api/v1/sso/callback endpoint to REST API docs (#671)
This PR concludes the Complete API documentation project #43

Add documentation for the following endpoints:
- api/v1/status/live_query
- api/v1/status/result_store
- api/v1/sso/callback
2021-04-29 10:45:43 -04:00
Gabriel Hernandez
04712c0426 Merge master into teams 2021-04-14 17:52:15 +01:00
Joseph Henrich
7499f37cda
Fix promote/demote user doc (#629)
I believe this is just a copy/paste error from the enable/disable section.
2021-04-09 15:54:49 -07:00
Zach Wasserman
2f51493d20
Delete instead of disabling users (#622)
- Migration to delete existing disabled users.
- Remove enabled attribute.
- Add endpoint for user deletion.
2021-04-08 16:53:33 -07:00
Zach Wasserman
fd13b3a72c
Fix carve documentation flag order (#605)
Update the docs to be consistent with stricter flag parsing in 3.10.

Fixes #602
2021-04-06 14:43:00 -07:00
Zach Wasserman
244983fd7a
Add filtering for invites (#600)
Uses the same API as for users and hosts.
2021-04-06 11:09:28 -07:00
Zach Wasserman
598c1e4c1f
Remove invited_by from invite parameters (#591)
Instead, use the value extracted from the viewer context.
2021-04-05 13:28:43 -07:00
Zach Wasserman
0bd6903b2d
Add version endpoint to API (#549)
Part of #371
2021-03-26 18:03:31 -07:00
Mike Thomas
dce7910411
Using Fleet text update (#522)
Updated text to match the new UI screenshots.
2021-03-23 08:16:05 -05:00
noahtalerman
2c341ee755
Fix broken anchor links in documentation (#509)
This PR includes various fixes to anchor links used in the documentation.

There are certain characters GitHub doesn't support for the use of anchor links in markdown files. The general rule I've found is to only use a-z or A-Z characters in anchor links. All other characters should be removed.

For example, consider the section title How do I connect to the Mailhog simulated server?. The valid GitHub anchor link for this section is #how-do-i-connect-to-the-mailhog-simulated-server. Notice no ?.

Closes #494
2021-03-21 16:05:11 -07:00
noahtalerman
a4fa53f514
Fix queries/run_by_names endpoint (#438)
The api/v1/fleet/queries/run_by_names endpoint was incorrectly documented as discussed in #409. This PR includes the fix.
- Add the query parameter to the queries/run_by_names endpoint and edit the example requests to include this parameter.
2021-03-11 15:59:00 -08:00
noahtalerman
06dc4c53f7
Remove support property from fleetctl docs. Edit run queries by name endpoint in api docs (#429)
This PR includes two documentation fixes.

1. Remove the support property from the osquery queries spec in the fleetctl docs. The support property is not a feature of osquery or Fleet.
2. Edit the api/v1/fleet/queries/run_by_names with accurate examples. This endpoint sends query targets (hosts and labels) by name (hostname and label name). Contrast this with the api/v1/fleet/queries/run which sends query targets by id (host id and label id)

Resolves #409
2021-03-09 15:41:10 -08:00
noahtalerman
dd7d5cd9a3
Add sessions, reset_password, and more endpoints to REST API docs (#382)
This PR is part of the Complete documentation for Fleet API project #43.

The endpoint included in these changes:
- POST /api/v1/fleet/reset_password
- GET /api/v1/fleet/sessions/{id}
- DELETE /api/v1/fleet/sessions/{id}
- POST /api/v1/fleet/queries/delete
- GET /api/v1/fleet/email/change/{token}
2021-03-09 07:50:48 -08:00
noahtalerman
46a04fbeef
Add documentation for websocket endpoints (#395)
Add documentation on the websocket endpoints in the Fleet API. These endpoints allow users to retrieve live query results.

Endpoints added include:
- `api/v1/fleet/results`
- `api/v1/fleet/results/websockets`
2021-03-08 16:08:47 -08:00
noahtalerman
53296ee930
Fix queries/run endpoint and queries/run_by_name (#411)
- Fix api/v1/fleet/queries/run endpoint. Prior the fix, the endpoint was incorrectly documented as api/v1/fleet/spec/queries/run
- Fix api/v1/fleet/queries/run_by_names endpoint. Prior the fix, the endpoint was incorrectly documented as api/v1/fleet/queries/run
2021-03-08 11:46:05 -08:00
Josh Brower
db0102d80c
JSON formatting fixes (#410)
- Adds correct formatting to JSON in several places in the REST API docs
2021-03-08 08:13:06 -08:00
noahtalerman
b283767574
Add file carve endpoints and remaining user endpoints to REST API docs (#346)
The endpoint included in these changes:
- /api/v1/kolide/carves GET
- /api/v1/kolide/carves/{id} GET
- /api/v1/kolide/users/{id} PATCH
- /api/v1/kolide/users/{id}/enable POST
- /api/v1/kolide/users/{id}/admin POST
- /api/v1/kolide/users/{id}/require_password_reset POST
- /api/v1/kolide/users/{id}/sessions GET
- /api/v1/kolide/users/{id}/sessions DELETE
2021-02-25 11:43:15 -08:00
Zach Wasserman
de0b3324b1
Add AWS Lambda as logging plugin (#347)
This plugin invokes the provided function with each log line as the
payload.

Closes #342
2021-02-24 10:02:26 -08:00