Use-WhoisOvertHTTP.psm1
|
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 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 |
# # Created by: lucas.cueff[at]lucas-cueff.com # # v0.1 : initial release # Released on: 03/2018 # #'(c) 2018 lucas-cueff.com - Distributed under Artistic Licence 2.0 (https://opensource.org/licenses/artistic-license-2.0).' <# .SYNOPSIS simple PowerShell commandline interface to use Whois RIPE Database REST API .DESCRIPTION Use-WhoisOverHTTP.psm1 module provides a commandline interface to RIPE Database REST API Please consult Wiki available on Ripe-NCC github : https://github.com/RIPE-NCC/whois/wiki/WHOIS-REST-API Please consult WhoIs query reference maunal : https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-query-reference-manual .NOTE Geolocation rest API is not implemented because this API is deprecated https://github.com/RIPE-NCC/whois/wiki/WHOIS-REST-API-geolocation .EXAMPLE C:\PS> import-module Use-WhoisOverHTTP.psm1 #> Function Get-Whois { <# .SYNOPSIS A Powershell function offering the well-known whois search via ripe whois rest-like interface. HTTP Status Codes : code description 200 Search successfull 400 Illegal input - incorrect value in one or more of the parameters 404 No object(s) found .DESCRIPTION Please consult Wiki available on Ripe-NCC github : https://github.com/RIPE-NCC/whois/wiki/WHOIS-REST-API-search Please consult WhoIs query reference maunal : https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-query-reference-manual .PARAMETER SearchInfo -SearchInfo string Mandadatory Search term, could be : ip, as number, org... .PARAMETER Sources -Sources string or array of the following strings : 'all','ripe','afrinic-grs','apnic-grs','arin-grs','jpirr-grs','lacnic-grs','radb-grs','ripe-grs' Mandatory Dynamic parameter validation based on Get-WhoisSources output Set the source to be used for whois. 'all' will use all the available sources. Use Update-WhoisInfoAsEnvVariable function to put available sources in cache using a global env variable and avoid unnecessary online request. .PARAMETER TypeFilter -TypeFilter string or array of strings : 'inet6num','route6','inetnum','route','domain','inet-rtr','mntner','organisation','person','role' Optional Dynamic parameter validation based on Get-WhoisObjectFilterFromString output If specified the results will be filtered by object-type, multiple type-filters can be specified. The filter available depends on the search term. .PARAMETER ReverseLookup -ReverseLookup string : 'abuse-c','abuse-mailbox','admin-c','auth','author','ds-rdata','fingerpr','form','ifaddr','irt-nfy','local-as','mbrs-by-ref','member-of','mnt-by','mnt-domains','mnt-irt','mnt-lower','mnt-nfy','mnt-ref','mnt-routes','notify','nserver','org','origin','ping-hdl','ref-nfy','tech-c','upd-to','zone-c' Optional Dynamic parameter validation based on Get-WhoisAllObjectsInverseKey output If used, the query is an inverse lookup on the given attribute, if not specified the query is a direct lookup search. Use Update-WhoisInfoAsEnvVariable function to put available sources in cache using a global env variable and avoid unnecessary online request. .PARAMETER Flags -Flags string or array of strings :'show-personal','no-personal','no-filtering','no-referenced','no-irt' Optional 'show-personal' : Include referenced person and role objects in results. 'no-personal' : Filter referenced person and role objects from results. A client can be blocked for excessive querying of these objects. 'no-filtering' : Switches off default filtering of objects. 'no-referenced' : Switches off lookups for referenced contact information after retrieving the objects that match the lookup key. 'no-irt' : Filter IRT object (An irt object represents a Computer Security Incident Response Team (CSIRT)) .PARAMETER LimitResult -LimitResult string {number} Optional Limit result object number - Set a max object number to be get from the server .PARAMETER SimpleOutput -SimpleOutput {Switch} Optional filter the powershell object sent back from cdmlet to show attributes property .PARAMETER NoTLS -NoTLS {Switch} Optional Don't use TLS to communicate with RIPE server (HTTP only) .OUTPUTS TypeName : System.Management.Automation.PSCustomObject Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() objects NoteProperty System.Management.Automation.PSCustomObject objects=@{object=System.Object[]} parameters NoteProperty System.Management.Automation.PSCustomObject parameters=@{inverse-lookup=; type-fil... service NoteProperty System.Management.Automation.PSCustomObject service=@{name=search} terms-and-conditions NoteProperty System.Management.Automation.PSCustomObject terms-and-conditions=@{type=locator; h... Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() attributes NoteProperty System.Management.Automation.PSCustomObject attributes=@{attribute=System.Object[]} link NoteProperty System.Management.Automation.PSCustomObject link=@{type=locator; href=http://rest.db.ripe.n... primary-key NoteProperty System.Management.Automation.PSCustomObject primary-key=@{attribute=System.Object[]} source NoteProperty System.Management.Automation.PSCustomObject source=@{id=apnic-grs} .EXAMPLE Valid inverse lookup query on an org value, filtering by inetnum: C:\PS> Get-Whois -SearchInfo ORG-NCC1-RIPE -TypeFilter inetnum -ReverseLookup org -Sources ripe .EXAMPLE Search for objects of type organisation on the same query-string and specifying a preference for non recursion: C:\PS> Get-Whois -SearchInfo ORG-NCC1-RIPE -TypeFilter inetnum -Flags no-referenced -ReverseLookup org -Sources ripe .EXAMPLE A search on multiple sources and flags: C:\PS> get-whois -SearchInfo MAINT-APNIC-AP -Flags @('no-referenced','no-irt') -Sources all .EXAMPLE A search on multiple sources and multiple type-filters: C:\PS> Get-Whois -SearchInfo google -Sources all -TypeFilter @('person','organisation') .EXAMPLE A search on multiple sources and multiple type-filters and limit results to 5 entries: C:\PS> Get-Whois -SearchInfo google -Sources all -TypeFilter @('person','organisation') -LimiResult 5 .EXAMPLE A search on multiple sources and multiple type-filters and force communication to web service to HTTP only C:\PS> Get-Whois -SearchInfo google -Sources all -TypeFilter @('person','organisation') -NoTLS .EXAMPLE A search on multiple sources and multiple type-filters with a simplify output: C:\PS> Get-Whois -SearchInfo google -Sources all -TypeFilter @('person','organisation') -SimpleOutput #> [cmdletbinding()] param( [parameter(ValueFromPipelineByPropertyName=$true,ValueFromPipeline=$true,Mandatory=$true,Position=1)] [string]$SearchInfo, [parameter(Mandatory=$false,Position=5)] [ValidateSet('show-personal','no-personal','no-filtering','no-referenced','no-irt')] [Array]$Flags, [parameter(Mandatory=$false,Position=6)] [ValidateScript({($_ -match "\d+")})] [string]$LimitResult, [parameter(Mandatory=$false,Position=7)] [switch]$SimpleOutput, [parameter(Mandatory=$false,Position=8)] [switch]$NoTLS ) # https://blogs.technet.microsoft.com/pstips/2014/06/09/dynamic-validateset-in-a-dynamic-parameter/ DynamicParam { $ParameterNameSource = 'Sources' $RuntimeParameterDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary $AttributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] $ParameterAttribute = New-Object System.Management.Automation.ParameterAttribute $ParameterAttribute.ValueFromPipeline = $false $ParameterAttribute.ValueFromPipelineByPropertyName = $false $ParameterAttribute.Mandatory = $true $ParameterAttribute.Position = 2 $AttributeCollection.Add($ParameterAttribute) If ($global:GLBWhoisSources) { $arrSet = $global:GLBWhoisSources } ElseIf ($env:GLBWhoisSources) { $arrSet = $env:GLBWhoisSources -split " " } Else { $arrSet = Get-WhoisSources -SimpleOutput } $arrSet += 'all' $ValidateSetAttribute = New-Object System.Management.Automation.ValidateSetAttribute($arrSet) $AttributeCollection.Add($ValidateSetAttribute) $RuntimeParameter = New-Object System.Management.Automation.RuntimeDefinedParameter($ParameterNameSource, [string], $AttributeCollection) $RuntimeParameterDictionary.Add($ParameterNameSource, $RuntimeParameter) $ParameterNameTypeFilter = 'TypeFilter' $AttributeCollection2 = New-Object System.Collections.ObjectModel.Collection[System.Attribute] $ParameterAttribute2 = New-Object System.Management.Automation.ParameterAttribute $ParameterAttribute2.ValueFromPipeline = $false $ParameterAttribute2.ValueFromPipelineByPropertyName = $false $ParameterAttribute2.Mandatory = $false $ParameterAttribute2.Position = 3 $AttributeCollection2.Add($ParameterAttribute2) $arrSet = Get-WhoisObjectFilterFromString -InputString $SearchInfo $ValidateSetAttribute2 = New-Object System.Management.Automation.ValidateSetAttribute($arrSet) $AttributeCollection2.Add($ValidateSetAttribute2) $RuntimeParameter2 = New-Object System.Management.Automation.RuntimeDefinedParameter($ParameterNameTypeFilter, [array], $AttributeCollection2) $RuntimeParameterDictionary.Add($ParameterNameTypeFilter, $RuntimeParameter2) $ParameterNameReverseLookup = 'ReverseLookup' $AttributeCollection3 = New-Object System.Collections.ObjectModel.Collection[System.Attribute] $ParameterAttribute3 = New-Object System.Management.Automation.ParameterAttribute $ParameterAttribute3.ValueFromPipeline = $false $ParameterAttribute3.ValueFromPipelineByPropertyName = $false $ParameterAttribute3.Mandatory = $false $ParameterAttribute3.Position = 4 $AttributeCollection3.Add($ParameterAttribute3) if ($global:GLBWhoisObjetsInverseKey) { $arrSet = $global:GLBWhoisObjetsInverseKey } ElseIf ($env:GLBWhoisObjetsInverseKey) { $arrSet = $env:GLBWhoisObjetsInverseKey -split " " } Else { $arrSet = Get-WhoisAllObjectsInverseKey -SimpleOutput } $ValidateSetAttribute3 = New-Object System.Management.Automation.ValidateSetAttribute($arrSet) $AttributeCollection3.Add($ValidateSetAttribute3) $RuntimeParameter3 = New-Object System.Management.Automation.RuntimeDefinedParameter($ParameterNameReverseLookup, [string], $AttributeCollection3) $RuntimeParameterDictionary.Add($ParameterNameReverseLookup, $RuntimeParameter3) return $RuntimeParameterDictionary } Begin { $Sources = $PsBoundParameters[$ParameterNameSource] $TypeFilter = $PsBoundParameters[$ParameterNameTypeFilter] $ReverseLookup = $PsBoundParameters[$ParameterNameReverseLookup] } Process { $baseurl = "query-string=$($SearchInfo)&resource-holder&abuse-contact" If ($sources -eq "all") { $tmpurl = (Get-WhoisSources -SimpleOutput) -join "&source=" $tmpurl = "&source=$($tmpurl)" $baseurl="$($baseurl)$($tmpurl)" } Else { $baseurl="$($baseurl)&source=$($sources)" } If ($ReverseLookup) { $baseurl="$($baseurl)&inverse-attribute=$($ReverseLookup)" } If ($TypeFilter) { If ($TypeFilter.count -gt 1) { $tmpurl = $TypeFilter -join "&type-filter=" $tmpurl = "&type-filter=$($tmpurl)" $baseurl="$($baseurl)$($tmpurl)" } Else { $baseurl="$($baseurl)&type-filter=$($TypeFilter)" } } If ($Flags) { If ($Flags.count -gt 1) { $tmpurl = $Flags -join "&flags=" $tmpurl = "&flags=$($tmpurl)" $baseurl="$($baseurl)$($tmpurl)" } Else { $baseurl="$($baseurl)&flags=$($Flags)" } } IF ($LimitResult) { $baseurl = "$($baseurl)&limit=$($LimitResult)" } } End { if ($NoTLS.IsPresent) { $result = Invoke-WhoisOverHTTP -NoTLS -APIType search -value $baseurl } else { $result = Invoke-WhoisOverHTTP -APIType search -value $baseurl } if ($SimpleOutput.IsPresent) { if ($result.errormessages) { return $result.errormessages } else { return $result.objects.object } } else { return $result } } } function Get-WhoisSources { <# .SYNOPSIS A Powershell function requesting WHOIS REST API Metadata to list available Whois sources (A WhoisResource containing all available sources) HTTP Status Codes : code description 200 Search successfull .DESCRIPTION Please consult Wiki available on Ripe-NCC github : https://github.com/RIPE-NCC/whois/wiki/WHOIS-REST-API-metadata#listsources Please consult WhoIs query reference maunal : https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-query-reference-manual .PARAMETER SimpleOutput -SimpleOutput {Switch} Optional filter the powershell object sent back from cdmlet to show attributes property .PARAMETER NoTLS -NoTLS {Switch} Optional Don't use TLS to communicate with RIPE server (HTTP only) .OUTPUTS TypeName : System.Management.Automation.PSCustomObject Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() link NoteProperty System.Management.Automation.PSCustomObject link=@{type=locator; href=http://rest.db.ripe.net/metadata/sources} service NoteProperty System.Management.Automation.PSCustomObject service=@{name=getSupportedDataSources} sources NoteProperty System.Management.Automation.PSCustomObject sources=@{source=System.Object[]} TypeName : System.String Name MemberType Definition ---- ---------- ---------- Clone Method System.Object Clone(), System.Object ICloneable.Clone() CompareTo Method int CompareTo(System.Object value), int CompareTo(string strB), int IComparable.CompareTo(System.Object obj), int IComparable[string].CompareTo(string other) Contains Method bool Contains(string value) CopyTo Method void CopyTo(int sourceIndex, char[] destination, int destinationIndex, int count) EndsWith Method bool EndsWith(string value), bool EndsWith(string value, System.StringComparison comparisonType), bool EndsWith(string value, bool ignoreCase, cultureinfo culture) Equals Method bool Equals(System.Object obj), bool Equals(string value), bool Equals(string value, System.StringComparison comparisonType), bool IEquatable[string].Equals(string other) GetEnumerator Method System.CharEnumerator GetEnumerator(), System.Collections.IEnumerator IEnumerable.GetEnumerator(), System.Collections.Generic.IEnumerator[char] IEnumerable[char].GetEnumerator() GetHashCode Method int GetHashCode() GetType Method type GetType() ... .EXAMPLE Get available Whois sources C:\PS> Get-WhoisSources .EXAMPLE Get available Whois sources and force communication to web service to HTTP only C:\PS> Get-WhoisSources -NoTLS .EXAMPLE Get available Whois sources and force communication to web service to HTTP only with a simplify output: C:\PS> Get-WhoisSources -SimpleOutput -NoTLS #> [cmdletbinding()] param( [parameter(Mandatory=$false)] [switch]$SimpleOutput, [parameter(Mandatory=$false)] [switch]$NoTLS ) if ($NoTLS.IsPresent) { $result = Invoke-WhoisOverHTTP -APIType metadata-source -NoTLS -value $WhoisObject } else { $result = Invoke-WhoisOverHTTP -APIType metadata-source -value $WhoisObject } if ($SimpleOutput.IsPresent) { if ($result.errormessages) { return $result.errormessages } else { return $result.sources.source.id } } else { return $result } } function Get-WhoisObjectTemplateInfo { <# .SYNOPSIS A Powershell function requesting WHOIS REST API Metadata to list available attributes for Whois template object (A WhoisResource containing the template of the specified type) HTTP Status Codes : code description 200 Search successful 400 Illegal input - incorrect objectType .DESCRIPTION Please consult Wiki available on Ripe-NCC github : https://github.com/RIPE-NCC/whois/wiki/WHOIS-REST-API-metadata#objecttemplate Please consult WhoIs query reference maunal : https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-query-reference-manual .PARAMETER WhoisObject -WhoisObject string from the following list : 'as-block','as-set','aut-num','domain','filter-set','inet6num','inetnum','inet-rtr','irt','key-cert','mntner','organisation','peering-set','person','poem','poetic-form','role','route','route6','route-set','rtr-set' Mandadatory .PARAMETER SimpleOutput -SimpleOutput {Switch} Optional filter the powershell object sent back from cdmlet to show attributes property .PARAMETER NoTLS -NoTLS {Switch} Optional Don't use TLS to communicate with RIPE server (HTTP only) .OUTPUTS TypeName : System.Management.Automation.PSCustomObject Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() link NoteProperty System.Management.Automation.PSCustomObject link=@{type=locator; href=http://rest.db.ripe.net/metadata/templates/as-block} service NoteProperty System.Management.Automation.PSCustomObject service=@{name=getObjectTemplate} templates NoteProperty System.Management.Automation.PSCustomObject templates=@{template=System.Object[]} Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() cardinality NoteProperty string cardinality=SINGLE keys NoteProperty Object[] keys=System.Object[] name NoteProperty string name=as-block requirement NoteProperty string requirement=MANDATORY .EXAMPLE C:\PS> Get-WhoisObjectTemplateInfo -WhoisObject as-block .EXAMPLE A search on multiple sources and multiple type-filters and force communication to web service to HTTP only C:\PS> Get-WhoisObjectTemplateInfo -WhoisObject as-block -NoTLS .EXAMPLE A search on multiple sources and multiple type-filters with a simplify output: C:\PS> Get-WhoisObjectTemplateInfo -WhoisObject as-block -SimpleOutput #> [cmdletbinding()] param( [parameter(Mandatory=$true)] [ValidateSet('as-block','as-set','aut-num','domain','filter-set','inet6num','inetnum','inet-rtr','irt','key-cert','mntner','organisation','peering-set','person','poem','poetic-form','role','route','route6','route-set','rtr-set')] [string]$WhoisObject, [parameter(Mandatory=$false)] [switch]$SimpleOutput, [parameter(Mandatory=$false)] [switch]$NoTLS ) if ($NoTLS.IsPresent) { $result = Invoke-WhoisOverHTTP -APIType metadata-object -NoTLS -value $WhoisObject } else { $result = Invoke-WhoisOverHTTP -APIType metadata-object -value $WhoisObject } if ($SimpleOutput.IsPresent) { if ($result.errormessages) { return $result.errormessages } else { return $result.templates.template.attributes.attribute } } else { return $result } } function Get-WhoisAbuseContact { <# .SYNOPSIS A Powershell function taht you can use to lookup abuse contact email for an internet resource (IPv4 address, range or prefix, IPv6 address or prefix, AS number) using RIPE WHOIS REST Abuse API. HTTP Status Codes : code description 200 Search successful 404 No object(s) found .DESCRIPTION Please consult Wiki available on Ripe-NCC github : https://github.com/RIPE-NCC/whois/wiki/WHOIS-REST-API-abuse-contact Please consult WhoIs query reference maunal : https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-query-reference-manual .PARAMETER AbuseSearchValue -AbuseSearchValue string Mandadatory Search term, could be : ip, as number .PARAMETER SimpleOutput -SimpleOutput {Switch} Optional filter the powershell object sent back from cdmlet to show attributes property .PARAMETER NoTLS -NoTLS {Switch} Optional Don't use TLS to communicate with RIPE server (HTTP only) .OUTPUTS TypeName : System.Management.Automation.PSCustomObject Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() abuse-contacts NoteProperty System.Management.Automation.PSCustomObject abuse-contacts=@{key=OPS4-RIPE; email=abuse@ripe.net} link NoteProperty System.Management.Automation.PSCustomObject link=@{type=locator; href=http://rest.db.ripe.net/abuse-contact/AS3333} parameters NoteProperty System.Management.Automation.PSCustomObject parameters=@{primary-key=} service NoteProperty string service=abuse-contact terms-and-conditions NoteProperty System.Management.Automation.PSCustomObject terms-and-conditions=@{type=locator; href=http://www.ripe.net/db/support/db-terms-conditions.pdf} Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() email NoteProperty string email=abuse@ripe.net key NoteProperty string key=OPS4-RIPE .EXAMPLE Lookup abuse contact email for AS number AS3333 C:\PS> Get-WhoisAbuseContact AS3333 .EXAMPLE Lookup abuse contact email for IP 89.89.115.192 C:\PS> Get-WhoisAbuseContact 89.89.115.192 .EXAMPLE Lookup abuse contact email for AS number AS3333 and force communication to web service to HTTP only C:\PS> Get-WhoisAbuseContact AS3333 -SimpleOutput -NoTLS .EXAMPLE Lookup abuse contact email for AS number AS3333 with a simplify output: C:\PS> Get-WhoisAbuseContact AS3333 -SimpleOutput #> [cmdletbinding()] param( [parameter(Mandatory=$true)] [string]$AbuseSearchValue, [parameter(Mandatory=$false)] [switch]$SimpleOutput, [parameter(Mandatory=$false)] [switch]$NoTLS ) if ($NoTLS.IsPresent) { $result = Invoke-WhoisOverHTTP -APIType abuse -NoTLS -value $AbuseSearchValue } else { $result = Invoke-WhoisOverHTTP -APIType abuse -value $AbuseSearchValue } if ($SimpleOutput.IsPresent) { if ($result.errormessages) { return $result.errormessages } else { return $result.'abuse-contacts' } } else { return $result } } function Invoke-WhoisOverHTTP { <# .SYNOPSIS A Powershell function used to send request to ripe whois rest-like interface this function is used by other functions included in this module like : Get-Whois, Get-WhoisSources, Get-WhoisObjectTemplateInfo HTTP Status Codes : code description 200 Search successful 400 Illegal input - incorrect value in one or more of the parameters 404 No object(s) found .DESCRIPTION Please consult Wiki available on Ripe-NCC github : https://github.com/RIPE-NCC/whois/wiki/WHOIS-REST-API-search Please consult WhoIs query reference maunal : https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-query-reference-manual .PARAMETER APIType -APIType string from the follozing list : 'search','metadata-source','metadata-object','abuse' Mandatory 'search' : use the search API 'metadata-source' : use the metadata API and request the source object 'metadata-object' : use the metadata API and request a template object 'abuse' : use the abuse API .PARAMETER Value -Value string Mandadatory part of the URL with value and parameters required to call the APIType set .PARAMETER NoTLS -NoTLS {Switch} Optional Don't use TLS to communicate with RIPE server (HTTP only) .OUTPUTS TypeName : System.Management.Automation.PSCustomObject Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() objects NoteProperty System.Management.Automation.PSCustomObject objects=@{object=System.Object[]} parameters NoteProperty System.Management.Automation.PSCustomObject parameters=@{inverse-lookup=; type-fil... service NoteProperty System.Management.Automation.PSCustomObject service=@{name=search} terms-and-conditions NoteProperty System.Management.Automation.PSCustomObject terms-and-conditions=@{type=locator; h... Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() attributes NoteProperty System.Management.Automation.PSCustomObject attributes=@{attribute=System.Object[]} link NoteProperty System.Management.Automation.PSCustomObject link=@{type=locator; href=http://rest.db.ripe.n... primary-key NoteProperty System.Management.Automation.PSCustomObject primary-key=@{attribute=System.Object[]} source NoteProperty System.Management.Automation.PSCustomObject source=@{id=apnic-grs} #> [cmdletbinding()] param( [parameter(Mandatory=$true)] [ValidateSet('search','metadata-source','metadata-object','abuse')] [string]$APIType, [parameter(Mandatory=$false)] [string]$value, [parameter(Mandatory=$false)] [switch]$NoTLS ) if ($NoTLS.IsPresent) { $http = "http" } else { $http = "https" } $url = "$($http)://rest.db.ripe.net/" switch ($APIType) { 'search' {$url = "$($url)search.json?$($value)"} 'metadata-source' {$url = "$($url)metadata/sources.json"} 'metadata-object' {$url = "$($url)metadata/templates/$($value).json"} 'abuse' {$url = "$($url)abuse-contact/$($value).json"} } try { $webdata = invoke-webrequest $url -Headers @{"Accept" = "application/json"} } catch { $result = $_.Exception.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($result) $reader.BaseStream.Position = 0 $httpbody = $reader.ReadToEnd() $Filteredwebdata = $httpbody | Convertfrom-Json } try { If (!$Filteredwebdata) { $Filteredwebdata = $webdata.content | convertfrom-json } } catch { write-warning "Error when parsing Json file" write-error "Error Type: $($_.Exception.GetType().FullName)" write-error "Error Message: $($_.Exception.Message)" return } return $Filteredwebdata } function Get-WhoisObjectFilterFromString { <# .SYNOPSIS internal function used by Get-Whois to retrieve the appropriate filter for a search value. .DESCRIPTION internal function used by Get-Whois to retrieve the appropriate filter for a search value. .PARAMETER InputString -InputString string Mandadatory Search term, could be : ip, as number, org... .OUTPUTS TypeName : System.String Name MemberType Definition ---- ---------- ---------- Clone Method System.Object Clone(), System.Object ICloneable.Clone() CompareTo Method int CompareTo(System.Object value), int CompareTo(string strB), int IComparable.CompareTo(System.Object obj), int IComparable[string].CompareTo(string other) Contains Method bool Contains(string value) CopyTo Method void CopyTo(int sourceIndex, char[] destination, int destinationIndex, int count) EndsWith Method bool EndsWith(string value), bool EndsWith(string value, System.StringComparison comparisonType), bool EndsWith(string value, bool ignoreCase, cultureinfo culture) Equals Method bool Equals(System.Object obj), bool Equals(string value), bool Equals(string value, System.StringComparison comparisonType), bool IEquatable[string].Equals(string other) GetEnumerator Method System.CharEnumerator GetEnumerator(), System.Collections.IEnumerator IEnumerable.GetEnumerator(), System.Collections.Generic.IEnumerator[char] IEnumerable[char].GetEnumerator() GetHashCode Method int GetHashCode() GetType Method type GetType() ... #> [cmdletbinding()] param( [parameter(ValueFromPipelineByPropertyName=$true,ValueFromPipeline=$true,Mandatory=$true)] [string]$InputString ) switch -regex ($InputString) { '(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])' {$filter = @('inetnum','route')} 's*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?' {$filter = @('inet6num','route6')} '(AS)(\d+)' {$filter = @('domain','inetnum','inet6num','mntner','organisation','person','role')} default {$filter = @('domain','inetnum','inet6num','inet-rtr','mntner','organisation','person','role')} } if ($filter) {return $filter} } function Get-WhoisObjectInverseKeyFromObject { <# .SYNOPSIS use Get-WhoisObjectTemplateInfo to retrieve reverse lookup attribute for a whois object .DESCRIPTION use Get-WhoisObjectTemplateInfo to retrieve reverse lookup attribute for a whois object .PARAMETER WhoisObject -WhoisObject string from the following list : 'as-block','as-set','aut-num','domain','filter-set','inet6num','inetnum','inet-rtr','irt','key-cert','mntner','organisation','peering-set','person','poem','poetic-form','role','route','route6','route-set','rtr-set' Mandadatory .PARAMETER SimpleOutput -SimpleOutput {Switch} Optional filter the powershell object sent back from cdmlet to show attributes property .OUTPUTS TypeName : System.Management.Automation.PSCustomObject Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() cardinality NoteProperty string cardinality=MULTIPLE keys NoteProperty Object[] keys=System.Object[] name NoteProperty string name=mbrs-by-ref requirement NoteProperty string requirement=OPTIONAL TypeName : System.String Name MemberType Definition ---- ---------- ---------- Clone Method System.Object Clone(), System.Object ICloneable.Clone() CompareTo Method int CompareTo(System.Object value), int CompareTo(string strB), int IComparable.CompareTo(System.Object obj), int IComparable[string].CompareTo(string other) Contains Method bool Contains(string value) CopyTo Method void CopyTo(int sourceIndex, char[] destination, int destinationIndex, int count) EndsWith Method bool EndsWith(string value), bool EndsWith(string value, System.StringComparison comparisonType), bool EndsWith(string value, bool ignoreCase, cultureinfo culture) Equals Method bool Equals(System.Object obj), bool Equals(string value), bool Equals(string value, System.StringComparison comparisonType), bool IEquatable[string].Equals(string other) GetEnumerator Method System.CharEnumerator GetEnumerator(), System.Collections.IEnumerator IEnumerable.GetEnumerator(), System.Collections.Generic.IEnumerator[char] IEnumerable[char].GetEnumerator() GetHashCode Method int GetHashCode() GetType Method type GetType() ... .EXAMPLE get INVERSE_KEY attribute foras-set whois template object C:\PS> Get-WhoisObjectInverseKeyFromObject -WhoisObject as-set .EXAMPLE get INVERSE_KEY attribute foras-set whois template object with a simplify output C:\PS> Get-WhoisObjectInverseKeyFromObject -WhoisObject as-set -SimpleOutput #> [cmdletbinding()] param( [parameter(Mandatory=$true)] [ValidateSet('as-block','as-set','aut-num','domain','filter-set','inet6num','inetnum','inet-rtr','irt','key-cert','mntner','organisation','peering-set','person','poem','poetic-form','role','route','route6','route-set','rtr-set')] [string]$WhoisObject, [parameter(Mandatory=$false)] [switch]$SimpleOutput ) $result = Get-WhoisObjectTemplateInfo -WhoisObject $WhoisObject -SimpleOutput | Where-Object {$_.keys -contains "INVERSE_KEY"} If ($SimpleOutput.IsPresent) { if ($result.name) { return $result.name } else { return $result.errormessages } } Else { return $result } } function Get-WhoisAllObjectsInverseKey { <# .SYNOPSIS use Get-WhoisObjectInverseKeyFromObject to retrieve all reverse lookup attribute for all whois template objects .DESCRIPTION use Get-WhoisObjectInverseKeyFromObject to retrieve all reverse lookup attribute for all whois template objects .PARAMETER SimpleOutput -SimpleOutput {Switch} Optional filter the powershell object sent back from cdmlet to show attributes property .OUTPUTS TypeName : System.Management.Automation.PSCustomObject Name MemberType Definition ---- ---------- ---------- Equals Method bool Equals(System.Object obj) GetHashCode Method int GetHashCode() GetType Method type GetType() ToString Method string ToString() cardinality NoteProperty string cardinality=MULTIPLE keys NoteProperty Object[] keys=System.Object[] name NoteProperty string name=org requirement NoteProperty string requirement=OPTIONAL TypeName : System.String Name MemberType Definition ---- ---------- ---------- Clone Method System.Object Clone(), System.Object ICloneable.Clone() CompareTo Method int CompareTo(System.Object value), int CompareTo(string strB), int IComparable.CompareTo(System.Object obj), int IComparable[string].CompareTo(string other) Contains Method bool Contains(string value) CopyTo Method void CopyTo(int sourceIndex, char[] destination, int destinationIndex, int count) EndsWith Method bool EndsWith(string value), bool EndsWith(string value, System.StringComparison comparisonType), bool EndsWith(string value, bool ignoreCase, cultureinfo culture) Equals Method bool Equals(System.Object obj), bool Equals(string value), bool Equals(string value, System.StringComparison comparisonType), bool IEquatable[string].Equals(string other) GetEnumerator Method System.CharEnumerator GetEnumerator(), System.Collections.IEnumerator IEnumerable.GetEnumerator(), System.Collections.Generic.IEnumerator[char] IEnumerable[char].GetEnumerator() GetHashCode Method int GetHashCode() GetType Method type GetType() ... #> [cmdletbinding()] param( [parameter(Mandatory=$false)] [switch]$SimpleOutput ) $WhoisObjects = @('as-block','as-set','aut-num','domain','filter-set','inet6num','inetnum','inet-rtr','irt','key-cert','mntner','organisation','peering-set','person','poem','poetic-form','role','route','route6','route-set','rtr-set') $results = @() ForEach ($object in $WhoisObjects) { $results += Get-WhoisObjectInverseKeyFromObject -WhoisObject $object } if ($SimpleOutput.IsPresent) { return $results.name | Sort-Object | Get-Unique } Else { return $results } } function Update-WhoisInfoAsVariable { <# .SYNOPSIS Set Whois sources and inverse_key object attribute as global variable or env variable (GLBWhoisSources and GLBWhoisObjetsInverseKey) Those variables are automatically checked by Get-Whois main function .DESCRIPTION Set Whois sources and inverse_key object attribute as global variable or env variable (GLBWhoisSources and GLBWhoisObjetsInverseKey) Those variables are automatically checked by Get-Whois main function .PARAMETER Clear -Clear {Switch} Optional Clear all variables .PARAMETER Scope -Scope string from this list : 'GlobalVariable','EnvVariable' Optional 'GlobalVariable' : set scope to global variable 'EnvVariable' : set scope to env. variable .OUTPUTS none .EXAMPLE clear all env and global variable C:\PS> Update-WhoisInfoAsVariable -clear .EXAMPLE set content as global variable C:\PS> Update-WhoisInfoAsVariable -scope GlobalVariable .EXAMPLE set content as env variable C:\PS> Update-WhoisInfoAsVariable -scope EnvVariable #> [cmdletbinding()] param( [parameter(Mandatory=$false)] [ValidateSet('GlobalVariable','EnvVariable')] [string]$scope, [parameter(Mandatory=$false)] [switch]$Clear ) if ($clear.IsPresent) { $global:GLBWhoisSources = $null $global:GLBWhoisObjetsInverseKey = $null [System.Environment]::SetEnvironmentVariable('GLBWhoisSources', '', [System.EnvironmentVariableTarget]::User) [System.Environment]::SetEnvironmentVariable('GLBWhoisObjetsInverseKey', '', [System.EnvironmentVariableTarget]::User) } Else { $tmpSources = Get-WhoisSources -SimpleOutput $tmpObjInvKey = Get-WhoisAllObjectsInverseKey -SimpleOutput If ($scope -eq "EnvVariable") { [System.Environment]::SetEnvironmentVariable('GLBWhoisSources', $tmpSources, [System.EnvironmentVariableTarget]::User) [System.Environment]::SetEnvironmentVariable('GLBWhoisObjetsInverseKey', $tmpObjInvKey, [System.EnvironmentVariableTarget]::User) } Else { $global:GLBWhoisSources = $tmpSources $global:GLBWhoisObjetsInverseKey = $tmpObjInvKey } } } Export-ModuleMember -Function Update-WhoisInfoAsVariable, Invoke-WhoisOverHTTP, Get-WhoisAbuseContact, Get-WhoisSources, Get-Whois, Get-WhoisObjectTemplateInfo, Get-WhoisObjectFilterFromString, Get-WhoisAllObjectsInverseKey, Get-WhoisObjectInverseKeyFromObject |