diff mbox series

[1/4] doc: document AP properties PairwiseCiphers/GroupCipher

Message ID 20221103173057.381232-1-prestwoj@gmail.com (mailing list archive)
State New
Headers show
Series [1/4] doc: document AP properties PairwiseCiphers/GroupCipher | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
prestwoj/iwd-alpine-ci-fetch success Fetch PR
prestwoj/iwd-ci-gitlint success GitLint
prestwoj/iwd-ci-fetch success Fetch PR
prestwoj/iwd-alpine-ci-makedistcheck success Make Distcheck
prestwoj/iwd-ci-makedistcheck success Make Distcheck
prestwoj/iwd-alpine-ci-build success Build - Configure
prestwoj/iwd-ci-build success Build - Configure
prestwoj/iwd-alpine-ci-makecheckvalgrind success Make Check w/Valgrind
prestwoj/iwd-alpine-ci-makecheck success Make Check
prestwoj/iwd-ci-clang success clang PASS
prestwoj/iwd-ci-makecheckvalgrind success Make Check w/Valgrind
prestwoj/iwd-ci-makecheck success Make Check
prestwoj/iwd-alpine-ci-incremental_build success Incremental Build with patches
prestwoj/iwd-ci-incremental_build success Incremental Build with patches
prestwoj/iwd-ci-testrunner success test-runner PASS

Commit Message

James Prestwood Nov. 3, 2022, 5:30 p.m. UTC
---
 doc/access-point-api.txt | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Marcel Holtmann Nov. 3, 2022, 6:17 p.m. UTC | #1
Hi James,

> ---
> doc/access-point-api.txt | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
> 
> diff --git a/doc/access-point-api.txt b/doc/access-point-api.txt
> index 63e61d49..28e6437d 100644
> --- a/doc/access-point-api.txt
> +++ b/doc/access-point-api.txt
> @@ -71,3 +71,16 @@ Properties	boolean Started [readonly]
> 		uint32 Frequency [readonly, optional]
> 
> 			The frequency that the Access Point is operating on.
> +
> +		string PairwiseCiphers [readonly, optional]
> +
> +			Comma separated list of pairwise ciphers the access
> +			point supports. The same format as setting a list of
> +			ciphers for an AP  profile, i.e. TKIP, CCMP-128,
> +			GCMP-128, CCMP-256, GCMP-256 etc.

why not array{string} since that makes it a cleaner from an API point of view.

Regards

Marcel
James Prestwood Nov. 3, 2022, 7:01 p.m. UTC | #2
On Thu, 2022-11-03 at 19:17 +0100, Marcel Holtmann wrote:
> Hi James,
> 
> > ---
> > doc/access-point-api.txt | 13 +++++++++++++
> > 1 file changed, 13 insertions(+)
> > 
> > diff --git a/doc/access-point-api.txt b/doc/access-point-api.txt
> > index 63e61d49..28e6437d 100644
> > --- a/doc/access-point-api.txt
> > +++ b/doc/access-point-api.txt
> > @@ -71,3 +71,16 @@ Properties   boolean Started [readonly]
> >                 uint32 Frequency [readonly, optional]
> > 
> >                         The frequency that the Access Point is
> > operating on.
> > +
> > +               string PairwiseCiphers [readonly, optional]
> > +
> > +                       Comma separated list of pairwise ciphers
> > the access
> > +                       point supports. The same format as setting
> > a list of
> > +                       ciphers for an AP  profile, i.e. TKIP,
> > CCMP-128,
> > +                       GCMP-128, CCMP-256, GCMP-256 etc.
> 
> why not array{string} since that makes it a cleaner from an API point
> of view.

We could do this yes. The implemenation has already been merged but we
could change this to an array easy enough.

> 
> Regards
> 
> Marcel
>
Denis Kenzior Nov. 3, 2022, 7:28 p.m. UTC | #3
Hi James,

>> why not array{string} since that makes it a cleaner from an API point
>> of view.

Yeah, I concur this would be better.

> 
> We could do this yes. The implemenation has already been merged but we
> could change this to an array easy enough.
> 

Yep, lets do that.

Regards,
-Denis
diff mbox series

Patch

diff --git a/doc/access-point-api.txt b/doc/access-point-api.txt
index 63e61d49..28e6437d 100644
--- a/doc/access-point-api.txt
+++ b/doc/access-point-api.txt
@@ -71,3 +71,16 @@  Properties	boolean Started [readonly]
 		uint32 Frequency [readonly, optional]
 
 			The frequency that the Access Point is operating on.
+
+		string PairwiseCiphers [readonly, optional]
+
+			Comma separated list of pairwise ciphers the access
+			point supports. The same format as setting a list of
+			ciphers for an AP  profile, i.e. TKIP, CCMP-128,
+			GCMP-128, CCMP-256, GCMP-256 etc.
+
+		string GroupCipher [readonly, optional]
+
+			The group cipher suite the access point is using.
+			Possible values are the same as what could be included
+			in the PairwiseCiphers list.