diff mbox series

[FFmpeg-devel,1/3] doc/http: Update HTTP protocol options

Message ID 1595073385-29007-1-git-send-email-mypopydev@gmail.com
State Accepted
Commit 68c56082d3888d7c1aba9f518ee9ad73850b7e31
Headers show
Series [FFmpeg-devel,1/3] doc/http: Update HTTP protocol options
Related show

Checks

Context Check Description
andriy/default pending
andriy/make success Make finished
andriy/make_fate success Make fate finished

Commit Message

Jun Zhao July 18, 2020, 11:56 a.m. UTC
From: Jun Zhao <barryjzhao@tencent.com>

remove the timeout option docs part for HTTP protocol and add
auth_type option part.

Signed-off-by: Jun Zhao <barryjzhao@tencent.com>
---
 doc/protocols.texi | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

Comments

Gyan Doshi July 18, 2020, 3:34 p.m. UTC | #1
On 18-07-2020 05:26 pm, Jun Zhao wrote:
> From: Jun Zhao <barryjzhao@tencent.com>
>
> remove the timeout option docs part for HTTP protocol and add
> auth_type option part.
>
> Signed-off-by: Jun Zhao <barryjzhao@tencent.com>
> ---
>   doc/protocols.texi | 27 ++++++++++++++++++++++-----
>   1 file changed, 22 insertions(+), 5 deletions(-)
>
> diff --git a/doc/protocols.texi b/doc/protocols.texi
> index 64ad3f0..7b3df96 100644
> --- a/doc/protocols.texi
> +++ b/doc/protocols.texi
> @@ -392,11 +392,6 @@ string describing the libavformat build. ("Lavf/<version>")
>   @item user-agent
>   This is a deprecated option, you can use user_agent instead it.
>   
> -@item timeout
> -Set timeout in microseconds of socket I/O operations used by the underlying low level
> -operation. By default it is set to -1, which means that the timeout is
> -not specified.
> -
>   @item reconnect_at_eof
>   If set then eof is treated like an error and causes reconnection, this is useful
>   for live / endless streams.
> @@ -481,6 +476,28 @@ Send an Expect: 100-continue header for POST. If set to 1 it will send, if set
>   to 0 it won't, if set to -1 it will try to send if it is applicable. Default
>   value is -1.
>   
> +@item auth_type
> +
> +Set HTTP authentication type. No option for Digest, since this method requires
> +getting nonce parameters from the server first and can't be used straight away like
> +Basic.
> +
> +@table @option
> +@item none
> +Choose the HTTP authentication type automatically. This is the default.
> +@item basic
> +
> +Choose the HTTP basic authentication.
> +
> +Basic authentication sends a Base64-encoded string that contains a user name and password
> +for the client. Base64 is not a form of encryption and should be considered the same as
> +sending the user name and password in clear text (Base64 is a reversible encoding).
> +If a resource needs to be protected, strongly consider using an authentication scheme
> +other than basic authentication. HTTPS/TLS should be used with basic authentication.
> +Without these additional security enhancements, basic authentication should not be used
> +to protect sensitive or valuable information.
> +@end table
> +
>   @end table
>   
>   @subsection HTTP Cookies

LGTM.

Gyan
mypopy@gmail.com July 20, 2020, 1:10 a.m. UTC | #2
On Sat, Jul 18, 2020 at 11:34 PM Gyan Doshi <ffmpeg@gyani.pro> wrote:
>
>
>
> On 18-07-2020 05:26 pm, Jun Zhao wrote:
> > From: Jun Zhao <barryjzhao@tencent.com>
> >
> > remove the timeout option docs part for HTTP protocol and add
> > auth_type option part.
> >
> > Signed-off-by: Jun Zhao <barryjzhao@tencent.com>
> > ---
> >   doc/protocols.texi | 27 ++++++++++++++++++++++-----
> >   1 file changed, 22 insertions(+), 5 deletions(-)
> >
> > diff --git a/doc/protocols.texi b/doc/protocols.texi
> > index 64ad3f0..7b3df96 100644
> > --- a/doc/protocols.texi
> > +++ b/doc/protocols.texi
> > @@ -392,11 +392,6 @@ string describing the libavformat build. ("Lavf/<version>")
> >   @item user-agent
> >   This is a deprecated option, you can use user_agent instead it.
> >
> > -@item timeout
> > -Set timeout in microseconds of socket I/O operations used by the underlying low level
> > -operation. By default it is set to -1, which means that the timeout is
> > -not specified.
> > -
> >   @item reconnect_at_eof
> >   If set then eof is treated like an error and causes reconnection, this is useful
> >   for live / endless streams.
> > @@ -481,6 +476,28 @@ Send an Expect: 100-continue header for POST. If set to 1 it will send, if set
> >   to 0 it won't, if set to -1 it will try to send if it is applicable. Default
> >   value is -1.
> >
> > +@item auth_type
> > +
> > +Set HTTP authentication type. No option for Digest, since this method requires
> > +getting nonce parameters from the server first and can't be used straight away like
> > +Basic.
> > +
> > +@table @option
> > +@item none
> > +Choose the HTTP authentication type automatically. This is the default.
> > +@item basic
> > +
> > +Choose the HTTP basic authentication.
> > +
> > +Basic authentication sends a Base64-encoded string that contains a user name and password
> > +for the client. Base64 is not a form of encryption and should be considered the same as
> > +sending the user name and password in clear text (Base64 is a reversible encoding).
> > +If a resource needs to be protected, strongly consider using an authentication scheme
> > +other than basic authentication. HTTPS/TLS should be used with basic authentication.
> > +Without these additional security enhancements, basic authentication should not be used
> > +to protect sensitive or valuable information.
> > +@end table
> > +
> >   @end table
> >
> >   @subsection HTTP Cookies
>
> LGTM.
>
Pused, thx
diff mbox series

Patch

diff --git a/doc/protocols.texi b/doc/protocols.texi
index 64ad3f0..7b3df96 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -392,11 +392,6 @@  string describing the libavformat build. ("Lavf/<version>")
 @item user-agent
 This is a deprecated option, you can use user_agent instead it.
 
-@item timeout
-Set timeout in microseconds of socket I/O operations used by the underlying low level
-operation. By default it is set to -1, which means that the timeout is
-not specified.
-
 @item reconnect_at_eof
 If set then eof is treated like an error and causes reconnection, this is useful
 for live / endless streams.
@@ -481,6 +476,28 @@  Send an Expect: 100-continue header for POST. If set to 1 it will send, if set
 to 0 it won't, if set to -1 it will try to send if it is applicable. Default
 value is -1.
 
+@item auth_type
+
+Set HTTP authentication type. No option for Digest, since this method requires
+getting nonce parameters from the server first and can't be used straight away like
+Basic.
+
+@table @option
+@item none
+Choose the HTTP authentication type automatically. This is the default.
+@item basic
+
+Choose the HTTP basic authentication.
+
+Basic authentication sends a Base64-encoded string that contains a user name and password
+for the client. Base64 is not a form of encryption and should be considered the same as
+sending the user name and password in clear text (Base64 is a reversible encoding).
+If a resource needs to be protected, strongly consider using an authentication scheme
+other than basic authentication. HTTPS/TLS should be used with basic authentication.
+Without these additional security enhancements, basic authentication should not be used
+to protect sensitive or valuable information.
+@end table
+
 @end table
 
 @subsection HTTP Cookies