usr/src/man/man3gen/isencrypt.3gen

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ISENCRYPT 3GEN "Dec 29, 1996"
   7 .SH NAME
   8 isencrypt \- determine whether a buffer of characters is encrypted
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR  [\fIflag\fR]... [\fIfile\fR]... \fB-lgen\fR [\fIlibrary\fR]...
  13 .fi
  14
  15 .LP
  16 .nf
  17 #include<libgen.h>
  18
  19 \fBint\fR \fBisencrypt\fR(\fBconst char *\fR\fIfbuf\fR, \fBsize_t\fR \fIninbuf\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 \fBisencrypt()\fR uses heuristics to determine whether a buffer of characters
  26 is encrypted. It requires two arguments: a pointer to an array of characters
  27 and the number of characters in the buffer.
  28 .sp
  29 .LP
  30 \fBisencrypt()\fR assumes that the file is not encrypted if all the characters
  31 in the first block are \fBASCII\fR characters. If there are non-\fBASCII\fR
  32 characters in the first \fIninbuf\fR characters, and if the \fBsetlocale()\fR
  33 \fBLC_CTYPE\fR category is set to \fBC\fR or \fBascii\fR, \fBisencrypt()\fR
  34 assumes that the buffer is encrypted
  35 .sp
  36 .LP
  37 If the \fBLC_CTYPE\fR category is set to a value other than \fBC\fR or
  38 \fBascii\fR, then \fBisencrypt()\fR uses a combination of heuristics to
  39 determine if the buffer is encrypted. If \fIninbuf\fR has at least 64
  40 characters, a chi-square test is used to determine if the bytes in the buffer
  41 have a uniform distribution; if it does, then \fBisencrypt()\fR assumes the
  42 buffer is encrypted.  If the buffer has less than 64 characters, a check is
  43 made for null characters and a terminating  new-line to determine whether the
  44 buffer is encrypted.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 If the buffer is encrypted,  \fB1\fR is returned; otherwise, zero is returned.
  49 .SH ATTRIBUTES
  50 .sp
  51 .LP
  52 See \fBattributes\fR(5) for descriptions of the following attributes:
  53 .sp
  54
  55 .sp
  56 .TS
  57 box;
  58 c | c
  59 l | l .
  60 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  61 _
  62 MT-Level        MT-Safe
  63 .TE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBsetlocale\fR(3C), \fBattributes\fR(5)
  69 .SH NOTES
  70 .sp
  71 .LP
  72 When compiling multithreaded applications, the \fB_REENTRANT\fR flag must be
  73 defined on the compile line.  This flag should only be used in multithreaded
  74 applications.