106 lines
6.1 KiB
HTML
106 lines
6.1 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>Shodan.Net: Readme</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Shodan.Net
|
|
</div>
|
|
<div id="projectbrief">c# client for the shodan api</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Readme </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>Visit the official <a class="el" href="namespace_shodan.html">Shodan</a> API documentation at:</p>
|
|
<p><a href="https://developer.shodan.io">https://developer.shodan.io</a></p>
|
|
<p>This is still in active development, error handling might not well handle well. Best bet when working with any libraries you didn't write..harden your calls!</p>
|
|
<h2>Installation</h2>
|
|
<p><code>install-package <a class="el" href="namespace_shodan_1_1_net.html">Shodan.Net</a></code></p>
|
|
<h2>Getting started</h2>
|
|
<p>You need to have an Api key. Get your <a href="http://www.shodanhq.com/api_doc">api key here</a>.</p>
|
|
<p>Create a shodan client. Note that ShodanClient inerhits from IDisposable, so you should wrap it in a using, or make sure it will be disposed. <a class="el" href="namespace_shodan.html">Shodan</a> client is thread safe, so you should be able to keep 1 object around for many requests.</p>
|
|
<p><code>var client = new <a class="el" href="class_shodan_1_1_net_1_1_shodan_client.html" title="Main mechanism to talk to the shodan api. This is what you should use to interact with the api ...">Shodan.Net.ShodanClient</a>("myapiKey");</code></p>
|
|
<p>Now just query away.</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> await client.GetPortsAsync();</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> await client.GetHostAsync("172.1.1.0");</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> await client.GetMyIpAsync();</div></div><!-- fragment --><h2>Searching</h2>
|
|
<p>Searching shodan requires you to build up queries, and facets to make it easier we have used a generator pattern to produce queries.</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> await client.SearchHosts(</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  query: a => a.Withcity("boston")</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  .Withcountry("usa")</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  .Before(DateTime.Now.AddDays(-5)),</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  facet: b => b.WithAsn()</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  );</div></div><!-- fragment --><h2>APi Docs</h2>
|
|
<p>You can find doxygen docs <a href="http://shodan-csharp-docs.azurewebsites.net/">here</a> </p>
|
|
</div></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|