original/man3/memfrob.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\" Modified Sat Jul 24 18:54:45 1993 by Rik Faith (faith@cs.unc.edu)
  28 .TH MEMFROB 3  2010-09-10 "GNU" "Linux Programmer's Manual"
  29 .SH NAME
  30 memfrob \- frobnicate (encrypt) a memory area
  31 .SH SYNOPSIS
  32 .nf
  33 .BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
  34 .B #include <string.h>
  35 .sp
  36 .BI "void *memfrob(void *" s ", size_t " n );
  37 .fi
  38 .SH DESCRIPTION
  39 The
  40 .BR memfrob ()
  41 function encrypts the first \fIn\fP bytes of the
  42 memory area \fIs\fP by exclusive-ORing each character with the number
  43 42.
  44 The effect can be reversed by using
  45 .BR memfrob ()
  46 on the
  47 encrypted memory area.
  48 .PP
  49 Note that this function is not a proper encryption routine as the XOR
  50 constant is fixed, and is only suitable for hiding strings.
  51 .SH "RETURN VALUE"
  52 The
  53 .BR memfrob ()
  54 function returns a pointer to the encrypted memory
  55 area.
  56 .SH "CONFORMING TO"
  57 The
  58 .BR memfrob ()
  59 function is unique to the
  60 GNU C Library.
  61 .SH "SEE ALSO"
  62 .BR strfry (3)