MS-LUF / Use-Onyphe

Simple PowerShell module to use Onyphe.io API

Use-Onyphe

Simple PowerShell module to use Onyphe.io API

Onyphe.io provides data about IP address space and publicly available information in just one place.

Some of the APIs required an API key. To request it : https://www.onyphe.io/login

More info about available APIs : https://www.onyphe.io/documentation/api

(c) 2018-2021 lucas-cueff.com Distributed under Artistic Licence 2.0 (https://opensource.org/licenses/artistic-license-2.0).

Notes version (1.3) - last public version :

• add whois simple API
• update bulk APIs
• add simple best APIs
• minor improvement
• new aliases : Export-OnypheBulkSimple, Export-OnypheBulkSummary
• new functions : Export-OnypheBulkInfo, Export-OnypheBulkSummaryInfo
• updated functions : Get-OnypheInfo
• update csv templates

Notes version (1.2) :

• add bulk APIs
• update code to optimize file export (best memory management)
• update object type to PSOnyphe
• update inputobject parameter to InputOnypheObject on all functions
• fix various bug found

Notes version (1.1) :

• add new APIv2, migrate from APIv1 to full APIv2 (except bulk API that will be provided in 1.2)
  • sample csv files are updated to take into account new API and new api naming convention, please check them and update your current CSV file using the new templates.
• remove temporary fix for empty array in APIv2
• update deserialization of psobject

Notes version (1.00) :

• fix rate limiting issue on paging
• manage new API in Export-OnypheInfoToFile

Notes version (0.99) :

• replace $env:appdata with $home for Linux and Powershell Core compatibility
• create new function to request APIv2 (Invoke-OnypheAPIV2) and managing api key as new header etc...
• rename previous function to request APIv1 (Invoke-OnypheAPIV1) and fix Net.WebException management for PowerShell core
• create new functions to deal with Onyphe Alert APIs (Invoke-APIOnypheListAlert, Invoke-APIOnypheDelAlert, Invoke-APIOnypheAddAlert)
• create new functions for managing the Onyphe Alert (Get-OnypheAlertInfo, Set-OnypheAlertInfo)

Notes version (0.98) :

• fix paging regex to support more than 1000 pages

Notes version (0.97) :

• code improvement
• add beta switch to use beta interface of onyphe instead of production one
• improve paging parameters
• add advancedfilter option to Search-onyphe to manage multiple filter functions input
• add onionshot category to datashot export function

Notes version (0.96) :

• add new filtering function for search request
• add Get-OnypheSearchFunctions function
• update Invoke-APIOnypheSearch and Search-OnypheInfo functions
• replace SimpleSearchfilter parameter with SimpleSearchfilter
• replace SimpleSearchValue parameter with SearchValue
• add FunctionFilter and FunctionValue parameters
• update Get-OnypheInfoFromCSV to manage new filter function in search request
• add new alias Get-OnypheInfoFromCSV

Notes version (0.95) :

• fix HTTP error on invoke-onyphe when no network is available
• add datashot management
• add function to export datashot to picture file
• fix Get-OnypheInfoFromCSV
• update Export-OnypheInfoToFile

Notes version (0.94) :

• manage new apis (ctl, sniffer, onionscan, md5)
• use userinfos API to collect APIs and search filters
• rewrite get-onyphe info function to simplify the code
• update invoke-apionyphedatascan with only a single parameter

Notes version (0.93)

• add statistics function

Notes version (0.92)

• add tag filter
• manage new search APIs
• code refactoring
• fix file export for new categories and properties
• manage proxy connection
• manage API key storage with encryption in a config file
• add paging feature on search and info functions

How-to

an updated how-to is now available here : https://github.com/MS-LUF/Use-Onyphe/blob/master/Howto.md

install use-onyphe from PowerShell Gallery repository

You can easily install it from powershell gallery repository https://www.powershellgallery.com/packages/Use-Onyphe/ using a simple powershell command and an internet access :-)

	Install-Module -Name Use-Onyphe

import module from PowerShell

	.SYNOPSIS 
	commandline interface to use onyphe.io web service

	.DESCRIPTION
	use-onyphe.psm1 module provides a commandline interface to onyphe.io web service.
	
	.EXAMPLE
	C:\PS> import-module use-onyphe.psm1

module content

documentation in markdown available here : https://github.com/MS-LUF/Use-Onyphe/tree/master/docs

function

• Get-OnypheUserInfo
• Search-OnypheInfo
• Get-OnypheInfo
• Get-OnypheInfoFromCSV
• Export-OnypheInfoToFile
• Export-OnypheDataShot
• Export-OnypheBulkInfo
• Export-OnypheBulkSummaryInfo
• Export-OnypheInfo
• Get-OnypheSummaryAPIName
• Get-OnypheSummary
• Get-OnypheSimpleBestAPIName
• Get-OnypheBulkCategories
• Get-OnypheBulkAPIType
• Get-OnypheSearchFunctions
• Get-OnypheSearchCategories
• Get-OnypheSearchFilters
• Set-OnypheAPIKey
• Update-OnypheFacetsFilters
• Get-OnypheCliFacets
• Get-OnypheStatsFromObject
• Set-OnypheProxy
• Import-OnypheEncryptedIKey
• Get-OnypheSimpleAPIName
• Get-OnypheAlertInfo
• Set-OnypheAlertInfo

alias

• Export-Onyphe
• Get-Onyphe
• Get-OnypheAlert
• Get-OnypheFromCSV
• Search-Onyphe
• Set-OnypheAlert
• Update-OnypheLocalData
• Export-OnypheBulkSimple
• Export-OnypheBulkSummary