Skip to content

Adding softAP SSID & PSK query API #4138

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 18 commits into from
Mar 28, 2018
Merged

Adding softAP SSID & PSK query API #4138

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
e5c6259
softAP SSID & PSK query API added.
IMAN4K Jan 11, 2018
3b79cb4
Fix for proper C-style string copy
IMAN4K Jan 17, 2018
04d96d9
Merge branch 'master' into master
IMAN4K Jan 18, 2018
6501ba4
Merge branch 'master' into master
IMAN4K Jan 18, 2018
9f3e1bd
Merge branch 'master' into master
IMAN4K Jan 20, 2018
1d74009
Merge branch 'master' into master
devyte Jan 24, 2018
0f6979f
Merge branch 'master' into master
IMAN4K Jan 24, 2018
3ecd00f
Merge branch 'master' into master
IMAN4K Jan 28, 2018
bff42fd
Merge branch 'master' into master
IMAN4K Feb 12, 2018
0339f5e
Merge branch 'master' of github.com:esp8266/Arduino
IMAN4K Feb 19, 2018
dcf64e1
add API to validate input ip as string
IMAN4K Feb 19, 2018
a62c5ab
fix indentation
IMAN4K Feb 19, 2018
60b4a1d
Merge branch 'master' into master
IMAN4K Feb 22, 2018
3a80358
Merge branch 'master' into master
devyte Mar 9, 2018
641d6c5
Merge branch 'master' into master
devyte Mar 18, 2018
a2fe942
Merge branch 'master' into master
IMAN4K Mar 25, 2018
0309ded
Merge branch 'master' into master
IMAN4K Mar 28, 2018
6ca28ab
fix ip string validation to use built-in implementation.
IMAN4K Mar 28, 2018
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
47 changes: 47 additions & 0 deletions cores/esp8266/IPAddress.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,51 @@ String IPAddress::toString() const
return String(szRet);
}

/* ref: https://code.woboq.org/userspace/glibc/resolv/inet_pton.c.html#inet_pton4 */
static bool inet_pton4(const char *start, const char *end) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this function different from IPAddress::fromString(), found here? If they serve equivalent purpose, I'd rather not duplicate.

Copy link
Contributor Author

@IMAN4K IMAN4K Mar 23, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@devyte
So sorry for late reply.
You say we should modify bool IPAddress::fromString(const char *address) function for adding validate support ? without duplicate
Because current IPAddress public API doesn't support validating IPV4 as string

Copy link
Contributor Author

@IMAN4K IMAN4K Mar 23, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@devyte
My suggestion:
1.Adding a private validating method:
static bool IPAddress::isValid(const char* arg, size_t len);
2.Adding correspond public method:
static bool IPAddress::isValid(const String& ip);
3.Reuse method of 1 inside 2 and bool IPAddress::fromString(const char *address) function

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@IMAN4K said:

Because current IPAddress public API doesn't support validating IPV4 as string

Are you saying that the following does not validate a string?
bool isvalid = IPAddress().fromString("17604123874106239");

Copy link
Contributor Author

@IMAN4K IMAN4K Mar 24, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@devyte
Yes that's correct, my mistake!
But we need to make an object for every validation.
It's better with a public static member(with good api name isValid rather than fromString), then every where in code:
if (IPAddress::isValid(...)) ...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The object constructed is 4 bytes in size, essentially one int, which is a temporary instantiated on the stack and immediately destroyed, so that's not a problem (btw, destruction is trivial).
What I suggest is a static convenience method like you propose, but something like this:

bool IPAddress::isValid(const char *str)
{
  return IPAddress().fromString(str);
}
bool IPAddress::isValid(String &str)
{
  return IPAddress().fromString(str);
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok.
I'll make changes very soon.

bool saw_digit = false;
char ch;
uint8_t octets = 0;
unsigned char tmp[4], *tp;
*(tp = tmp) = 0;

while (start < end) {
ch = *start++;
if (isdigit(ch)) {
unsigned int _new = *tp * 10 + (ch - '0');
if (saw_digit && *tp == 0)
return false;
if (_new > 255)
return false;
*tp = _new;
if (!saw_digit) {
if (++octets > 4)
return false;
saw_digit = true;
}
} else if (ch == '.' && saw_digit) {
if (octets == 4)
return false;
*++tp = 0;
saw_digit = false;
} else {
return false;
}
}

if (octets < 4)
return false;

return true;
}

bool IPAddress::isValid(const String& arg) {
auto c_str = arg.c_str();
return inet_pton4(c_str, c_str + arg.length());
}

bool IPAddress::isValid(const char* arg, size_t len) {
return inet_pton4(arg, arg + len);
}

const IPAddress INADDR_NONE(0, 0, 0, 0);
8 changes: 8 additions & 0 deletions cores/esp8266/IPAddress.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ class IPAddress: public Printable {
virtual size_t printTo(Print& p) const;
String toString() const;

/*
check if input string(arg) is a valid IPV4 address or not.
return true on valid.
return false on invalid.
*/
static bool isValid(const String& arg);
static bool isValid(const char* arg, size_t len);

friend class EthernetClass;
friend class UDP;
friend class Client;
Expand Down
30 changes: 30 additions & 0 deletions libraries/ESP8266WiFi/src/ESP8266WiFiAP.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,3 +339,33 @@ String ESP8266WiFiAPClass::softAPmacAddress(void) {
sprintf(macStr, "%02X:%02X:%02X:%02X:%02X:%02X", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
return String(macStr);
}

/**
* Get the configured(Not-In-Flash) softAP SSID name.
* @return String SSID.
*/
String ESP8266WiFiAPClass::softAPSSID() const {
struct softap_config config;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation in this function is different from nearby functions

wifi_softap_get_config(&config);
char* name = reinterpret_cast<char*>(config.ssid);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not just

config.ssid[sizeof(config.ssid) - 1] = 0; // guard
return String((const char*)(void*)config.ssid) ?

String(char*) will anyway search for the last \0

Copy link
Contributor Author

@IMAN4K IMAN4K Jan 24, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@d-a-v
Based on @devyte comment, user must be able to configure 64 byte length PSK at max, not 63

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK sorry I did not see the hidden-outdated comment.

char ssid[sizeof(config.ssid) + 1];
memcpy(ssid, name, sizeof(config.ssid));
ssid[sizeof(config.ssid)] = '\0';

return String(ssid);
}

/**
* Get the configured(Not-In-Flash) softAP PSK or PASSWORD.
* @return String psk.
*/
String ESP8266WiFiAPClass::softAPPSK() const {
struct softap_config config;
wifi_softap_get_config(&config);
char* pass = reinterpret_cast<char*>(config.password);
char psk[sizeof(config.password) + 1];
memcpy(psk, pass, sizeof(config.password));
psk[sizeof(config.password)] = '\0';

return String(psk);
}
3 changes: 3 additions & 0 deletions libraries/ESP8266WiFi/src/ESP8266WiFiAP.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ class ESP8266WiFiAPClass {
uint8_t* softAPmacAddress(uint8_t* mac);
String softAPmacAddress(void);

String softAPSSID() const;
String softAPPSK() const;

protected:

};
Expand Down