---
name: "gss_wrap_size_limit"
section: "3"
platform: "linux"
package: "gss-man"
version: "1.0.4-4"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/gss_wrap_size_limit"
---

# gss\_wrap\_size\_limit(3)

API function

## NAME

gss\_wrap\_size\_limit - API function

## SYNOPSIS

**#include \<gss.h\>**

**OM\_uint32 gss\_wrap\_size\_limit(OM\_uint32 \*** *minor\_status***, const gss\_ctx\_id\_t** *context\_handle***, int** *conf\_req\_flag***, gss\_qop\_t** *qop\_req***, OM\_uint32** *req\_output\_size***, OM\_uint32 \*** *max\_input\_size***);**

## ARGUMENTS

- OM\_uint32 \* minor\_status

  (Integer, modify) Mechanism specific status code.

- const gss\_ctx\_id\_t context\_handle

  (gss\_ctx\_id\_t, read) A handle that refers to the\
     security over which the messages will be sent.

- int conf\_req\_flag

  (Boolean, read) Indicates whether gss\_wrap will be\
     asked to apply confidentiality protection in addition to\
     integrity protection.  See the routine description for gss\_wrap\
     for more details.

- gss\_qop\_t qop\_req

  (gss\_qop\_t, read) Indicates the level of protection that\
     gss\_wrap will be asked to provide.  See the routine description\
     for gss\_wrap for more details.

- OM\_uint32 req\_output\_size

  (Integer, read) The desired maximum size for\
     tokens emitted by gss\_wrap.

- OM\_uint32 \* max\_input\_size

  (Integer, modify) The maximum input message size\
     that may be presented to gss\_wrap in order to guarantee that the\
     emitted token shall be no larger than req\_output\_size bytes.

## DESCRIPTION

Allows an application to determine the maximum message size that, if presented to gss\_wrap with the same conf\_req\_flag and qop\_req parameters, will result in an output token containing no more than req\_output\_size bytes.

This call is intended for use by applications that communicate over protocols that impose a maximum message size.  It enables the application to fragment messages prior to applying protection.

GSS-API implementations are recommended but not required to detect invalid QOP values when **gss\_wrap\_size\_limit()** is called. This routine guarantees only a maximum message size, not the availability of specific QOP values for message protection.

Successful completion of this call does not guarantee that gss\_wrap will be able to protect a message of length max\_input\_size bytes, since this ability may depend on the availability of system resources at the time that gss\_wrap is called.  However, if the implementation itself imposes an upper limit on the length of messages that may be processed by gss\_wrap, the implementation should not return a value via max\_input\_bytes that is greater than this length.

## RETURN VALUE

\`GSS\_S\_COMPLETE\`: Successful completion.

\`GSS\_S\_NO\_CONTEXT\`: The referenced context could not be accessed.

\`GSS\_S\_CONTEXT\_EXPIRED\`: The context has expired.

\`GSS\_S\_BAD\_QOP\`: The specified QOP is not supported by the mechanism.

## REPORTING BUGS

Report bugs to \<bug-gss@gnu.org\>. GNU Generic Security Service home page: http://www.gnu.org/software/gss/ General help using GNU software: http://www.gnu.org/gethelp/

## COPYRIGHT

Copyright © 2003-2022 Simon Josefsson.\
 Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.

## SEE ALSO

The full documentation for **gss** is maintained as a Texinfo manual.  If the **info** and **gss** programs are properly installed at your site, the command

-

  **info gss**

should give you access to the complete manual.