Skip to content

DNSServer can now be configured to reply to all requests with one IP address (e.g. for captive portal) #448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 26, 2015
Merged

DNSServer can now be configured to reply to all requests with one IP address (e.g. for captive portal) #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a97666
Added simple HTTP server to DNSServer example
knovoselic Jun 19, 2015
5deef1b
Added captive portal functionality
knovoselic Jun 19, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions hardware/esp8266com/esp8266/libraries/DNSServer/examples/CaptivePortal/CaptivePortal.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
#include <ESP8266WiFi.h>
#include <DNSServer.h>
#include <ESP8266WebServer.h>

const byte DNS_PORT = 53;
IPAddress apIP(192, 168, 1, 1);
DNSServer dnsServer;
ESP8266WebServer webServer(80);

String responseHTML = ""
"<!DOCTYPE html><html><head><title>CaptivePortal</title></head><body>"
"<h1>Hello World!</h1><p>This is a captive portal example. All requests will "
"be redirected here.</p></body></html>";

void setup() {
WiFi.mode(WIFI_AP);
WiFi.softAPConfig(apIP, apIP, IPAddress(255, 255, 255, 0));
WiFi.softAP("DNSServer CaptivePortal example");

// if DNSServer is started with "*" for domain name, it will reply with
// provided IP to all DNS request
dnsServer.start(DNS_PORT, "*", apIP);

// replay to all requests with same HTML
webServer.onNotFound([]() {
webServer.send(200, "text/html", responseHTML);
});
webServer.begin();
}

void loop() {
dnsServer.processNextRequest();
webServer.handleClient();
}
15 changes: 14 additions & 1 deletion hardware/esp8266com/esp8266/libraries/DNSServer/examples/DNSServer/DNSServer.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
#include <ESP8266WiFi.h>
#include <DNSServer.h>
#include <ESP8266WebServer.h>

const byte DNS_PORT = 53;
IPAddress apIP(192, 168, 1, 1);
DNSServer dnsServer;
ESP8266WebServer webServer(80);

void setup() {
WiFi.mode(WIFI_AP);
Expand All @@ -19,10 +21,21 @@ void setup() {
// default is DNSReplyCode::NonExistentDomain
dnsServer.setErrorReplyCode(DNSReplyCode::ServerFailure);

//start DNS server for a specific domain name
// start DNS server for a specific domain name
dnsServer.start(DNS_PORT, "www.example.com", apIP);

// simple HTTP server to see that DNS server is working
webServer.onNotFound([]() {
String message = "Hello World!\n\n";
message += "URI: ";
message += webServer.uri();

webServer.send(200, "text/plain", message);
});
webServer.begin();
}

void loop() {
dnsServer.processNextRequest();
webServer.handleClient();
}
2 changes: 1 addition & 1 deletion hardware/esp8266com/esp8266/libraries/DNSServer/library.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=DNSServer
version=1.0.0
version=1.1.0
author=Kristijan Novoselić
maintainer=Kristijan Novoselić, <[email protected]>
sentence=A simple DNS server for ESP8266.
Expand Down
3 changes: 2 additions & 1 deletion hardware/esp8266com/esp8266/libraries/DNSServer/src/DNSServer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ void DNSServer::processNextRequest()
if (_dnsHeader->QR == DNS_QR_QUERY &&
_dnsHeader->OPCode == DNS_OPCODE_QUERY &&
requestIncludesOnlyOneQuestion() &&
getDomainNameWithoutWwwPrefix() == _domainName)
(_domainName == "*" || getDomainNameWithoutWwwPrefix() == _domainName)
)
{
replyWithIP();
}
Expand Down
3 changes: 1 addition & 2 deletions hardware/esp8266com/esp8266/libraries/DNSServer/src/DNSServer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ struct DNSHeader
unsigned char AA : 1; // authoritive answer
unsigned char OPCode : 4; // message_type
unsigned char QR : 1; // query/response flag
unsigned char RCode : 4; // response code
unsigned char RCode : 4; // response code
unsigned char Z : 3; // its z! reserved
unsigned char RA : 1; // recursion available
uint16_t QDCount; // number of question entries
Expand Down Expand Up @@ -62,7 +62,6 @@ class DNSServer
uint32_t _ttl;
DNSReplyCode _errorReplyCode;


void downcaseAndRemoveWwwPrefix(String &domainName);
String getDomainNameWithoutWwwPrefix();
bool requestIncludesOnlyOneQuestion();
Expand Down