Manual de Referencia: kaneda

Kaneda — Auditor Estático de Seguridad en C y Detección de Funciones Inseguras Prohibidas¶

1. Propósito y Filosofía Pedagógica¶

La herramienta kaneda forma parte del ecosistema oficial de software de la cátedra. Su diseño sigue principios pedagógicos rigurosos:

1. Evidencia Técnica Directa: Todo diagnóstico se fundamenta en la norma ISO C (C11/C23), en el modelo de memoria del sistema o en convenciones arquitectónicas formales.

2. Acción Correctiva Concreta: Cada advertencia incluye la prescripción técnica inmediata para resolver el defecto sin recurrir a conjeturas.

3. Autonomía del Estudiante: Facilita la autoevaluación local antes de la entrega final del trabajo práctico.

4. Objetividad Docente: Estandariza la corrección automática removiendo discrepancias subjetivas en la evaluación.

2. Instalación y Verificación del Entorno¶

2.1 Requisitos Previos del Sistema¶

Instalá los paquetes del sistema requeridos según tu distribución o entorno:

2.2 Métodos de Instalación de kaneda¶

Podés instalar kaneda mediante cualquiera de los siguientes métodos estándar:

2.3 Autocompletado en la Shell¶

La interfaz CLI de kaneda cuenta con autocompletado nativo para comandos, flags y archivos. Para configurarlo permanentemente en tu shell:

# Configuración automática en Bash / Zsh / Fish
kaneda --install-completion

# Para cargar el autocompletado en la sesión actual de inmediato:
source ./install_tools.sh

2.4 Verificación del Entorno con doctor¶

Toda herramienta del ecosistema cuenta con el subcomando unificado doctor. Ejecutalo para auditar el estado del entorno:

kaneda doctor

Comprobaciones Ejecutadas por el Diagnóstico:¶

• Compilador C: Verifica disponibilidad de gcc o clang con soporte de estándares C11 y C23.

• Depurador y Core Dumps: Comprueba que gdb esté instalado y que ulimit -c permita generación de core dumps.

• Herramientas de Memoria: Valida la presencia de valgrind y librerías libasan/libubsan.

• Formateo y Estilo: Verifica el binario clang-format (versión 16+).

• Sandboxing de Kernel: Audita permisos no privilegiados de bwrap (Bubblewrap namespaces).

• Generador de Tipografía y Documentos: Comprueba typst ($\ge 0.11$) y dot (Graphviz).

Matriz de Resolución de Problemas:¶

3. Referencia Completa de Comandos CLI¶

A continuación se detallan los subcomandos principales disponibles en kaneda:

4. Tutorial Paso a Paso con Ejemplos Reales¶

Caso de Estudio¶

Considerá el siguiente fragmento de código representativo:

1
2
3
4
5
6
7
8
9
10
#include <stdio.h>
#include <string.h>

void vulnerabilidad_seguridad(void) {
    char buffer[16];
    gets(buffer);                     // Prohibido: Buffer Overflow crítico
    char destino[10];
    strcpy(destino, "Texto muy largo"); // Prohibido: Desborde
    printf(buffer);                   // Prohibido: Format String Vulnerability
}

Ejecución de la Herramienta¶

Ejecutá el análisis desde tu terminal:

kaneda audit src/ include/

Salida Obtenida en Consola¶

🚨 KANEDA SECURITY AUDIT REPORT: 3 vulnerabilidades críticas detectadas:
┌──────────────────┬──────────┬────────────────────────────────────────────────────────┐
│ Ubicación        │ Gravedad │ Vulnerabilidad y Acción Requerida                      │
├──────────────────┼──────────┼────────────────────────────────────────────────────────┤
│ auth.c:5:5       │ CRÍTICA  │ Uso de 'gets()'. Reemplazá obligatoriamente por fgets()│
│ auth.c:7:5       │ ALTA     │ 'strcpy()' sin límite. Usá strncpy() o snprintf()      │
│ auth.c:8:5       │ ALTA     │ Format string sin formato fijo. Usá printf("%s", buf)  │
└──────────────────┴──────────┴────────────────────────────────────────────────────────┘

5. Ejercicios Prácticos y Desafíos¶

Practicá el uso avanzado de kaneda resolviendo los siguientes ejercicios:

````{exercise} Desafío 2: Reemplazo de gets por fgets :label: kaneda-desafio-2 Corregir lectura de teclado manteniendo el tamaño del buffer.

Instrucción de ejecución:

kaneda scan src/login.c

````{solution} kaneda-desafio-2
```bash
kaneda scan src/login.c
# Revisá el archivo generado o el informe en terminal para confirmar la resolución del problema.
```

6. Integración en el Flujo de Trabajo y Makefile¶

Para incorporar kaneda de forma automática a tu flujo de desarrollo, agregá la siguiente regla en el Makefile de tu proyecto:

check-kaneda:
	@echo "=== Ejecutando verificación con kaneda ==="
	kaneda check src/ include/

.PHONY: check-kaneda

Ejecutá make check-kaneda antes de cada commit para mantener que tu código conserve el estado de aprobación.

7. Arquitectura Interna y Mecanismo Técnico¶

La herramienta kaneda implementa un motor de alta precisión basado en:

• Tecnología Núcleo: Clang Static Analyzer + Semgrep C Rules + Dangerous Functions AST Matcher.

• Aislamiento y Determinismo: Diseñada para operar sin efectos colaterales en entornos de integración continua (CI), terminales de estudiantes y servidores docentes headless.

• Manejo de Errores Pedagógico: Todo fallo de sintaxis, memoria o lógica se traduce en una acción prescriptiva concreta con su respectiva justificación técnica.

8. Integración y Conexión con el Ecosistema¶

Diagrama de Flujo e Interoperabilidad¶

Matriz de Intercambio de Datos¶

• dredd (bloqueo de entregas vulnerables) | Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización | ripley, daedalus, dredd | Validación cruzada, flags compartidos y autofix |

Pipeline de Integración Recomendado¶

Podés encadenar kaneda con otras herramientas del ecosistema en una única línea de comando:

# Pipeline de integración típico
kaneda audit src/ && ripley check src/

9. Extensión, Desarrollo de Plugins y API Python¶

Para crear tus propias reglas, conectores de evaluación o integrar kaneda programáticamente en pipelines de CI/CD:

• 👉 Consultá la guía completa: Guía de Extensión y Creación de Plugins