
Research
/Security News
Toptal’s GitHub Organization Hijacked: 10 Malicious Packages Published
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.
github.com/opeious/osquery
A non-obtrusive, idiomatic and easy-to-use query and aggregation builder for the official Go client for OpenSearch. Based on EsQuery
osquery
alleviates the need to use extremely nested maps (map[string]interface{}
) and serializing queries to JSON manually. It also helps eliminating common mistakes such as misspelling query types, as everything is statically typed.
Using osquery
can make your code much easier to write, read and maintain, and significantly reduce the amount of code you write. Wanna know how much code you'll save? just check this project's tests.
This is an early release, API may still change.
isquery
is a Go module. To install, simply run this in your project's root directory:
go get github.com/opeious/osquery
osquery provides a method chaining-style API for building and executing queries and aggregations. It does not wrap the official Go client nor does it require you to change your existing code in order to integrate the library. Queries can be directly built with osquery
, and executed by passing an *opensearch.Client
instance (with optional search parameters). Results are returned as-is from the official client (e.g. *opensearchapi.Response
objects).
Getting started is extremely simple:
package main
import (
"context"
"log"
"github.com/opeious/osquery"
"github.com/opensearch-project/opensearch-go"
)
func main() {
// connect to an OpenSearch instance
es, err := opensearch.NewDefaultClient()
if err != nil {
log.Fatalf("Failed creating client: %s", err)
}
// run a boolean search query
res, err := osquery.Search().
Query(
osquery.
Bool().
Must(osquery.Term("title", "Go and Stuff")).
Filter(osquery.Term("tag", "tech")),
).
Aggs(
osquery.Avg("average_score", "score"),
osquery.Max("max_score", "score"),
).
Size(20).
Run(
es,
es.Search.WithContext(context.TODO()),
es.Search.WithIndex("test"),
)
if err != nil {
log.Fatalf("Failed searching for stuff: %s", err)
}
defer res.Body.Close()
// ...
}
{ "query": { "term": { "user": "Kimchy" } } }
The library will always generate this:
{ "query": { "term": { "user": { "value": "Kimchy" } } } }
This is also true for queries such as "bool", where fields like "must" can
either receive one query object, or an array of query objects. osquery
will
generate an array even if there's only one query object.
The following queries are currently supported:
OpenSearch DSL | osquery Function |
---|---|
"match" | Match() |
"match_bool_prefix" | MatchBoolPrefix() |
"match_phrase" | MatchPhrase() |
"match_phrase_prefix" | MatchPhrasePrefix() |
"match_all" | MatchAll() |
"match_none" | MatchNone() |
"multi_match" | MultiMatch() |
"exists" | Exists() |
"fuzzy" | Fuzzy() |
"ids" | IDs() |
"prefix" | Prefix() |
"range" | Range() |
"regexp" | Regexp() |
"term" | Term() |
"terms" | Terms() |
"terms_set" | TermsSet() |
"wildcard" | Wildcard() |
"bool" | Bool() |
"boosting" | Boosting() |
"constant_score" | ConstantScore() |
"dis_max" | DisMax() |
The following aggregations are currently supported:
OpenSearch DSL | osquery Function |
---|---|
"avg" | Avg() |
"weighted_avg" | WeightedAvg() |
"cardinality" | Cardinality() |
"max" | Max() |
"min" | Min() |
"sum" | Sum() |
"value_count" | ValueCount() |
"percentiles" | Percentiles() |
"stats" | Stats() |
"string_stats" | StringStats() |
"top_hits" | TopHits() |
"terms" | TermsAgg() |
The following top level options are currently supported:
OpenSearch DSL | osquery.Search Function |
---|---|
"highlight" | Highlight() |
"explain" | Explain() |
"from" | From() |
"postFilter" | PostFilter() |
"query" | Query() |
"aggs" | Aggs() |
"size" | Size() |
"sort" | Sort() |
"source" | SourceIncludes(), SourceExcludes() |
"timeout" | Timeout() |
To execute an arbitrary query or aggregation (including those not yet supported by the library), use the CustomQuery()
or CustomAgg()
functions, respectively. Both accept any map[string]interface{}
value.
This library is distributed under the terms of the Apache License 2.0.
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.
Research
/Security News
Socket researchers investigate 4 malicious npm and PyPI packages with 56,000+ downloads that install surveillance malware.
Security News
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.